BitPlan CLI

The official CLI is published on the npm registry as bitplan. Machine readers can GET /api/v1/cli. Run npx bitplan or bunx bitplan. It talks to a BRC-100 wallet on this machine. The wallet owns every identity key and handles BRC-2 wrapping, unwrapping, signing, and funding. Shared payloads use the standard SDK symmetric cipher; the CLI holds no identity private keys.

Start the wallet

BSV Desktop is the usual one. The CLI defaults to a BRC-100-compatible JSON endpoint at http://127.0.0.1:3321. Use --wallet-url for another endpoint; start and unlock the wallet before key or spending commands. Shared uploads use ordinary BRC-100 encrypt requests for a 32-byte document key. Because BitPlan uses security level 2, the wallet can ask for permission for each new reader.

Check the connection

npx bitplan auth

bunx bitplan auth is the same command.

npx bitplan whoami
npx bitplan version

Config and file-to-origin mappings live in ~/.bitplan/. Neither file holds key material. Next: commands.

Search BitPlan

Jump to a BitPlan page, docs, or the npm CLI.