Commands

Every command is the same on npx bitplan and bunx bitplan.

  1. npx bitplan upload ./plan.html

    Publish a draft. bunx bitplan works the same.

  2. npx bitplan upload ./plan.html --relay

    Also send wallet BEEF through 1Sat; this may speed up the viewer.

  3. npx bitplan upload ./plan.html --description "migration, phase one"

    Optional label, shown in list and My drafts.

  4. npx bitplan upload ./plan.html --share-with <identity-key>

    Publish the next version for this wallet and the named reader.

  5. npx bitplan list

    Drafts this wallet holds.

  6. npx bitplan whoami

    Check the wallet and print its identity key.

  7. npx bitplan fetch <origin>

    Decrypt HTML to stdout.

  8. npx bitplan version

    Print the installed CLI version.

Flags

CommandFlags
upload <file>--draft <origin>, --new, --description <text>, --share-with <identity-key>, --private, --relay, -y, --allow-finding <id>
list--json, -v/--verbose, --limit <n>
fetch <origin|url>--meta, --version <n>
auth / whoami--wallet-url <url>, --json on whoami
versionprints the installed CLI version

--share-with is repeatable and additive, up to 128 readers. It publishes one encrypted document plus a small wallet-wrapped key per identity. --private makes only the new version wallet-only; older shared versions cannot be revoked. Shared drafts require CLI 0.0.6+ or the current website to read.

fetch --meta writes metadata to stderr, including whether the envelope is private or shared and the public reader list. HTML remains on stdout so it can be redirected to a file.

upload --relay sends the wallet-returned Atomic BEEF to 1Sat after publishing. 1Sat attempts to capture it for OrdFS and forwards the transaction to Arcade, which can make the viewer available sooner. Relay failure is a warning; it does not undo the wallet publish.

On-chain bytes are documented in the envelope spec.

Search BitPlan

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