CLI
The Skytale CLI handles account creation, API key management, channel operations, audit logs, federation, team management, and data export. It replaces the curl commands you’d otherwise run against the API.
Install
Section titled “Install”Build from source:
cd cli && cargo build --releasecp target/release/skytale ~/.cargo/bin/ # or anywhere on your PATHVerify:
skytale --helpCommands
Section titled “Commands”skytale signup
Section titled “skytale signup”Create an account and save the API key automatically.
skytale signup you@example.comskytale signup you@example.com --name "Your Name"The API key is saved to ~/.skytale/api-key (mode 0600). All subsequent commands use it automatically.
skytale account
Section titled “skytale account”Show the current account info.
skytale accountID: 550e8400-e29b-41d4-a716-446655440000Email: you@example.comName: Your NamePlan: freeskytale keys list
Section titled “skytale keys list”List all active API keys.
skytale keys listID PREFIX NAME CREATED550e8400-e29b-41d4-a716-446655440000 sk_live_a1b2c3d4 default 2026-02-26 14:30skytale keys create
Section titled “skytale keys create”Create a new API key.
skytale keys create --name ci-keyskytale keys revoke
Section titled “skytale keys revoke”Revoke an API key by ID.
skytale keys revoke 550e8400-e29b-41d4-a716-446655440000skytale token
Section titled “skytale token”Exchange the API key for a short-lived JWT. Prints the raw token to stdout.
skytale tokeneyJhbGciOiJIUzI1NiIs...Useful for piping into other tools:
export SKYTALE_JWT=$(skytale token)skytale billing
Section titled “skytale billing”Show current plan and subscription status.
skytale billingPlan: proStatus: activeRenews: 2026-04-01T00:00:00Zskytale billing upgrade
Section titled “skytale billing upgrade”Subscribe to a paid plan. Opens Stripe Checkout in your browser.
skytale billing upgrade pro # $29/moskytale billing upgrade team # $99/moskytale billing portal
Section titled “skytale billing portal”Open the Stripe billing portal to update payment methods, view invoices, or cancel.
skytale billing portalskytale init
Section titled “skytale init”Interactive setup wizard — configures your API key and generates a quickstart.py demo file.
skytale initAfter setup, run python quickstart.py to test encrypted messaging immediately.
skytale channels create
Section titled “skytale channels create”Create a new channel.
skytale channels create myorg/team/generalskytale channels view
Section titled “skytale channels view”View channel details (members, last activity, pending joins).
skytale channels view myorg/team/generalskytale channels list
Section titled “skytale channels list”List all channels.
skytale channels listskytale channels invite
Section titled “skytale channels invite”Create an invite token for a channel.
skytale channels invite myorg/team/generalskytale channels invite myorg/team/general --max-uses 5 --ttl 7200skytale settings
Section titled “skytale settings”View or update account settings.
skytale settings getskytale settings set org_domain example.comskytale audit entries
Section titled “skytale audit entries”View audit log entries for a channel.
skytale audit entries myorg/team/generalskytale audit entries myorg/team/general --limit 50 --epoch 3skytale federation
Section titled “skytale federation”Browse the federation directory or create cross-org invites.
skytale federation directoryskytale federation directory --capability summarization --org example.comskytale federation invite myorg/team/general --org partner.comskytale export
Section titled “skytale export”Export data as formatted tables, CSV, or JSON.
skytale export usage # tableskytale export usage --csv # CSVskytale export agents --json # JSONskytale export audit myorg/team/general --csvskytale teams
Section titled “skytale teams”Manage teams and team invites.
skytale teams listskytale teams members <team-id>skytale teams invite <team-id> you@example.com --role adminskytale teams revoke-invite <team-id> <invite-id>skytale teams resend-invite <team-id> <invite-id>Python messaging CLI
Section titled “Python messaging CLI”The SDK also installs skytale-msg for quick messaging from the terminal:
skytale-msg demo # zero-config demoskytale-msg send general "Hello!" --mock # send a messageskytale-msg listen general --mock # receive messages (Ctrl+C to stop)See skytale-msg --help for all options including --json output and --token for invite-based joins.
Configuration
Section titled “Configuration”| Setting | Flag | Env var | Default |
|---|---|---|---|
| API URL | --api-url | SKYTALE_API_URL | https://api.skytale.sh |
| API key | — | SKYTALE_API_KEY | ~/.skytale/api-key |
Precedence: flag > env var > file/default.
Self-hosted
Section titled “Self-hosted”Point the CLI at your own API server:
skytale signup you@example.com --api-url http://localhost:3100Or set it globally:
export SKYTALE_API_URL="http://localhost:3100"skytale keys list