Skip to content

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.

Build from source:

Terminal window
cd cli && cargo build --release
cp target/release/skytale ~/.cargo/bin/ # or anywhere on your PATH

Verify:

Terminal window
skytale --help

Create an account and save the API key automatically.

Terminal window
skytale signup you@example.com
skytale signup you@example.com --name "Your Name"

The API key is saved to ~/.skytale/api-key (mode 0600). All subsequent commands use it automatically.

Show the current account info.

Terminal window
skytale account
ID: 550e8400-e29b-41d4-a716-446655440000
Email: you@example.com
Name: Your Name
Plan: free

List all active API keys.

Terminal window
skytale keys list
ID PREFIX NAME CREATED
550e8400-e29b-41d4-a716-446655440000 sk_live_a1b2c3d4 default 2026-02-26 14:30

Create a new API key.

Terminal window
skytale keys create --name ci-key

Revoke an API key by ID.

Terminal window
skytale keys revoke 550e8400-e29b-41d4-a716-446655440000

Exchange the API key for a short-lived JWT. Prints the raw token to stdout.

Terminal window
skytale token
eyJhbGciOiJIUzI1NiIs...

Useful for piping into other tools:

Terminal window
export SKYTALE_JWT=$(skytale token)

Show current plan and subscription status.

Terminal window
skytale billing
Plan: pro
Status: active
Renews: 2026-04-01T00:00:00Z

Subscribe to a paid plan. Opens Stripe Checkout in your browser.

Terminal window
skytale billing upgrade pro # $29/mo
skytale billing upgrade team # $99/mo

Open the Stripe billing portal to update payment methods, view invoices, or cancel.

Terminal window
skytale billing portal

Interactive setup wizard — configures your API key and generates a quickstart.py demo file.

Terminal window
skytale init

After setup, run python quickstart.py to test encrypted messaging immediately.

Create a new channel.

Terminal window
skytale channels create myorg/team/general

View channel details (members, last activity, pending joins).

Terminal window
skytale channels view myorg/team/general

List all channels.

Terminal window
skytale channels list

Create an invite token for a channel.

Terminal window
skytale channels invite myorg/team/general
skytale channels invite myorg/team/general --max-uses 5 --ttl 7200

View or update account settings.

Terminal window
skytale settings get
skytale settings set org_domain example.com

View audit log entries for a channel.

Terminal window
skytale audit entries myorg/team/general
skytale audit entries myorg/team/general --limit 50 --epoch 3

Browse the federation directory or create cross-org invites.

Terminal window
skytale federation directory
skytale federation directory --capability summarization --org example.com
skytale federation invite myorg/team/general --org partner.com

Export data as formatted tables, CSV, or JSON.

Terminal window
skytale export usage # table
skytale export usage --csv # CSV
skytale export agents --json # JSON
skytale export audit myorg/team/general --csv

Manage teams and team invites.

Terminal window
skytale teams list
skytale teams members <team-id>
skytale teams invite <team-id> you@example.com --role admin
skytale teams revoke-invite <team-id> <invite-id>
skytale teams resend-invite <team-id> <invite-id>

The SDK also installs skytale-msg for quick messaging from the terminal:

Terminal window
skytale-msg demo # zero-config demo
skytale-msg send general "Hello!" --mock # send a message
skytale-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.

SettingFlagEnv varDefault
API URL--api-urlSKYTALE_API_URLhttps://api.skytale.sh
API keySKYTALE_API_KEY~/.skytale/api-key

Precedence: flag > env var > file/default.

Point the CLI at your own API server:

Terminal window
skytale signup you@example.com --api-url http://localhost:3100

Or set it globally:

Terminal window
export SKYTALE_API_URL="http://localhost:3100"
skytale keys list