CLI Reference

Complete reference for the bee1 command-line interface.

Global Options

bee1 [OPTIONS] COMMAND [ARGS]

Options:
  --version  Show version and exit
  --help     Show help and exit

Commands

bee1 init
Initialize a new identity by generating an Ed25519 keypair.
bee1 init [OPTIONS]

Options:
  --force  Overwrite existing keys

Creates ~/.bee1/ directory with:

  • private.key - Ed25519 private key (hex encoded)
  • public.key - Ed25519 public key (hex encoded)
  • config.json - Configuration file
bee1 register
Register your public key with HostSwarm using a trial code.
bee1 register --code CODE

Options:
  --code TEXT  Trial or pilot code (required)

On success, your account receives:

  • 5000 credits (500 scans)
  • ENS subdomain: yourorg.hostswarm.eth
  • Client ID stored in config
bee1 whoami
Display current identity and registration status.
bee1 whoami

Output:

Client ID: abc123def456...
Public Key: 7a3b9c4d5e6f...
Registered: Yes
ENS: floridaspine.hostswarm.eth
API: https://api.hostswarm.io
bee1 balance
Check your current credit balance.
bee1 balance

Output:

Credits: 4850
Scans remaining: 485
USD value: $48.50
bee1 submit
Submit a DICOM file for analysis.
bee1 submit FILE [OPTIONS]

Arguments:
  FILE  Path to DICOM file (.dcm) or ZIP archive

Options:
  --output, -o PATH  Output path for PDF report
  --wait/--no-wait   Wait for result (default: --wait)

Example:

bee1 submit spine_mri.dcm -o report.pdf

# Submit without waiting
bee1 submit spine_mri.dcm --no-wait
# Returns job ID for later retrieval
bee1 jobs
List recent analysis jobs.
bee1 jobs [OPTIONS]

Options:
  --limit INT  Number of jobs to show (default: 10)
bee1 job
Get details of a specific job.
bee1 job JOB_ID [OPTIONS]

Options:
  --download PATH  Download PDF report to path

Exit Codes

CodeMeaning
0Success
1General error
2Authentication error
3Insufficient credits
4File not found
5Network error