Install and Runtime

Runtime Baseline

peer-cli requires:

• Node >=22
• Base-compatible RPC connectivity for on-chain reads/writes
• Optional external API keys depending on command family

Install The CLI

Install the current release artifact:

npm install --global peer-protocol-cli@0.4.0
peer --help

The installed package is peer-protocol-cli; do not substitute the unrelated unscoped peer-cli package.

For tool-calling agents that only need reads, skip the install and use the hosted MCP server.

Develop From Source

Use this while developing the CLI itself:

npm install
npm run build
npm run test:coverage
npm run dev -- --help

Equivalent direct source execution:

npx tsx src/cli.ts --help

Validate the built artifact

Use this when validating the package behavior that a real install will expose:

npm run build
node dist/cli.cjs --help
node dist/cli.cjs quote --from USD --amount 100

Validate dist/cli.cjs because packaging issues can be invisible in source execution.

Integration Sources

The CLI and all three MCP profiles share the runtime in zkp2p/peer-cli. The former peer-cash-mcp repository and npm package are archived; new integrations use peer-protocol-cli.

The runtime uses @zkp2p/sdk for Curator quotes and maker registration, environment-aware contract operations, indexer queries, and attestation helpers. The SDK packages the selected contract ABIs and deployment manifests from @zkp2p/contracts-v2, and depends on @zkp2p/indexer-schema and @zkp2p/zkp2p-attestation. Peer Cash tools use @zkp2p/cash; they prepare unsigned plans while the host wallet retains signing authority.

This documentation app has no direct Curator, contract, indexer, or attestation client. Its pages and machine-readable documentation describe the installed runtime. Check its package version and generated contracts before executing a workflow; a healthy hosted MCP endpoint does not prove that a local install has the same version.

Environment Classes

Select one with --env <value>, PEER_ENV, or stored config.

Auth and Signing Inputs

Some command families only need network access. Others need a signer.

Signer resolution can come from:

• --private-key
• PEER_PRIVATE_KEY
• --wallet-path
• stored walletPath

Use --private-key only when unavoidable. It is visible in process listings.

Develop The Documentation Site

The agents.peer.xyz application lives in zkp2p-clients/clients/agents. It uses the monorepo's pnpm lockfile and canonical @zkp2p/brand package.

Useful local commands:

pnpm install
pnpm --filter @zkp2p/agents dev
pnpm --filter @zkp2p/agents typecheck
pnpm --filter @zkp2p/agents lint
pnpm --filter @zkp2p/agents build

Validation

When changing peer-cli itself:

npm run lint
npm run typecheck
npm run test:coverage
npm run build
node dist/cli.cjs --help

When changing the documentation app, run these from zkp2p-clients:

pnpm --filter @zkp2p/agents lint
pnpm --filter @zkp2p/agents typecheck
pnpm --filter @zkp2p/agents build