Orchard · 0.1.0 source manual

CLI help

Verbatim help captured from the compiled 0.1.0 release binary, including every subcommand.

These blocks are the output of --help from a local macOS arm64 release build of Orchard 0.1.0, except or help, captured with or help help. They describe the current source, not a published public tag. Aliases sw and ls use the same parsers as switch and members.

or

Ourcana system data on the command line

Usage: or [OPTIONS] <COMMAND>

Commands:
  who      Show who is currently fronting
  switch   Register a front switch
  members  List all members
  member   Show a member's detail card
  history  Show front history
  tags     List tags
  journal  List journal entries
  info     Show system info
  export   Export to a file
  login    Enroll an identity, or link another credential to this one
  logout   Forget an enrolled identity
  whoami   Show enrolled identities and the configured remote
  remote   Show or set the thatch server to sync with
  bind     Mint a gate entitlement token for the active identity
  pair     Pair this terminal with the Ourcana app
  connect  Open a WTP session and report the server's features
  online   Browse the data this identity has on the server, decrypted
  estate   Ask Ourcana Online what it knows about your identities
  import   Import from a file
  help     Print this message or the help of the given subcommand(s)

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help
  -V, --version        Print version

or who

Show who is currently fronting

Usage: or who [OPTIONS]

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or switch

Register a front switch

Usage: or switch [OPTIONS] <MEMBERS>...

Arguments:
  <MEMBERS>...  Member name(s) to switch to

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or members

List all members

Usage: or members [OPTIONS]

Options:
      --archived       Include archived members
  -s, --store <STORE>  Path to store (.json or .our)
      --fronting       Show only currently fronting
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or member

Show a member's detail card

Usage: or member [OPTIONS] <NAME>

Arguments:
  <NAME>  Member name (fuzzy matched)

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or history

Show front history

Usage: or history [OPTIONS]

Options:
  -n, --count <COUNT>  Number of entries to show [default: 10]
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or tags

List tags

Usage: or tags [OPTIONS]

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or journal

List journal entries

Usage: or journal [OPTIONS]

Options:
  -n, --count <COUNT>  Number of entries to show [default: 10]
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or info

Show system info

Usage: or info [OPTIONS]

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or export

Export to a file

Usage: or export [OPTIONS]

Options:
  -f, --format <FORMAT>  Output format [default: json] [possible values: json, our]
  -s, --store <STORE>    Path to store (.json or .our)
      --json             Output as JSON
  -o, --output <OUTPUT>  Output path
      --no-color         Disable colors
  -h, --help             Print help

Enroll an identity, or link another credential to this one

Usage: or login [OPTIONS]

Options:
      --route <ROUTE>        Credential route to enroll with. Defaults to the Ourcana app's identity when the app is signed in on this Mac, else local.device
  -s, --store <STORE>        Path to store (.json or .our)
      --json                 Output as JSON
      --list                 List the available credential routes and exit
      --link <SUBSPACE_HEX>  Sign a Meadowcap delegation to this 32-byte subspace key (hex)
      --no-color             Disable colors
      --read-only            With --link, grant read access instead of write
      --new                  Enroll again even when this route already has an identity here. For local.device that mints a whole new system; for app.keychain it re-reads whichever identity the app holds now
      --namespace <HEX>      Which app.keychain identity to enroll, by namespace id (a hex prefix will do). Needed when the app holds more than one. `or estate --all` says which of them Ourcana Online knows
  -h, --help                 Print help

or logout

Forget an enrolled identity

Usage: or logout [OPTIONS] [PREFIX]

Arguments:
  [PREFIX]  Namespace id prefix; omit to forget every identity

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or whoami

Show enrolled identities and the configured remote

Usage: or whoami [OPTIONS]

Options:
  -s, --store <STORE>    Path to store (.json or .our)
      --use-id <PREFIX>  Make the identity matching this namespace id prefix active
      --json             Output as JSON
      --no-color         Disable colors
  -h, --help             Print help

or remote

Show or set the thatch server to sync with

Usage: or remote [OPTIONS] [URL]

Arguments:
  [URL]  URL of the thatch /wtp endpoint (ws://, wss://, http:// or https://)

Options:
  -s, --store <STORE>          Path to store (.json or .our)
      --transport <TRANSPORT>  Which transport to use: http (default) or ws [possible values: http, ws]
      --json                   Output as JSON
      --no-color               Disable colors
  -h, --help                   Print help

or bind

Mint a gate entitlement token for the active identity

Usage: or bind [OPTIONS]

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or pair

Pair this terminal with the Ourcana app

Usage: or pair [OPTIONS]

Options:
      --accept <FILE|CODE>  Store a pairing payload: a file path, raw JSON, or a pasted code
  -s, --store <STORE>       Path to store (.json or .our)
      --forget              Forget the stored pairing and its token
      --json                Output as JSON
      --no-color            Disable colors
  -h, --help                Print help

or connect

Open a WTP session and report the server's features

Usage: or connect [OPTIONS]

Options:
  -s, --store <STORE>          Path to store (.json or .our)
      --timeout <TIMEOUT>      Per-read/write timeout in seconds [default: 30]
      --json                   Output as JSON
      --transport <TRANSPORT>  Override the configured transport for this run: http or ws [possible values: http, ws]
      --no-color               Disable colors
  -h, --help                   Print help

or online

Browse the data this identity has on the server, decrypted

Usage: or online [OPTIONS] <COMMAND>

Commands:
  ls    List entries, optionally under a path prefix
  cat   Print one entry's decrypted payload
  rm    Prune a subtree from the server
  help  Print this message or the help of the given subcommand(s)

Options:
  -s, --store <STORE>      Path to store (.json or .our)
      --json               Output as JSON
      --no-color           Disable colors
      --timeout <TIMEOUT>  Per-request timeout in seconds [default: 30]
      --namespace <HEX>    Act as this app.keychain identity (namespace id, a hex prefix will do) instead of the active one, without changing which is active
  -h, --help               Print help

or online ls

List entries, optionally under a path prefix

Usage: or online ls [OPTIONS] [PREFIX]

Arguments:
  [PREFIX]  Only entries at or under this decrypted path, e.g. `/n`

Options:
  -s, --store <STORE>      Path to store (.json or .our)
      --json               Output as JSON
      --no-color           Disable colors
      --timeout <TIMEOUT>  Per-request timeout in seconds [default: 30]
      --namespace <HEX>    Act as this app.keychain identity (namespace id, a hex prefix will do) instead of the active one, without changing which is active
  -h, --help               Print help

or online cat

Print one entry's decrypted payload

Usage: or online cat [OPTIONS] <PATH>

Arguments:
  <PATH>  The decrypted path, e.g. `/n/member-42`

Options:
      --no-verify          Print the payload even when it does not hash to the digest its signed entry commits to
  -s, --store <STORE>      Path to store (.json or .our)
      --json               Output as JSON
      --no-color           Disable colors
      --timeout <TIMEOUT>  Per-request timeout in seconds [default: 30]
      --namespace <HEX>    Act as this app.keychain identity (namespace id, a hex prefix will do) instead of the active one, without changing which is active
  -h, --help               Print help

or online rm

Prune a subtree from the server

Usage: or online rm [OPTIONS] [PREFIX]

Arguments:
  [PREFIX]  Everything at or under this decrypted path goes, e.g. `/a/front`

Options:
      --everything         Prune the whole namespace. There is no undo
  -s, --store <STORE>      Path to store (.json or .our)
      --json               Output as JSON
  -y, --yes                Skip the confirmation prompt
      --no-color           Disable colors
      --timeout <TIMEOUT>  Per-request timeout in seconds [default: 30]
      --namespace <HEX>    Act as this app.keychain identity (namespace id, a hex prefix will do) instead of the active one, without changing which is active
  -h, --help               Print help

or estate

Ask Ourcana Online what it knows about your identities

Usage: or estate [OPTIONS]

Options:
      --all            Survey every identity in the Ourcana app's keychain, not just the active one
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or import

Import from a file

Usage: or import [OPTIONS] <FILE>

Arguments:
  <FILE>  File to import (.json, .our, .zip)

Options:
  -s, --store <STORE>  Path to store (.json or .our)
      --json           Output as JSON
      --no-color       Disable colors
  -h, --help           Print help

or help

Print this message or the help of the given subcommand(s)

Usage: or help [COMMAND]...

Arguments:
  [COMMAND]...  Print help for the subcommand(s)