CLI Reference

Default stream output is summary-focused. Use kite stream --json for full CloudEvent payloads.

This page is generated from live CLI help output and kept in sync by CI.

x402 Mainnet Bootstrap

Bot-first onboarding is available through POST /api/v1/bootstrap/x402. Clerk login/device auth remains fully supported for dashboard users.

Paid Request Header Contract

Unpaid call returns 402 + payment-required. Paid retry must include payment-signature with base64 JSON PaymentPayload:

{"x402Version":2,"accepted":{...one entry from accepts[]...},"payload":{...signed scheme payload...}}

Legacy header fallbacks accepted: x-payment, x-payment-signature.

Required Server Env (Base mainnet)

X402_ENABLED=true
X402_FACILITATOR_URL (self-hosted: http://x402-facilitator:8080)
X402_BOOTSTRAP_CIPHER_KEY
X402_FACILITATOR_RPC_URL
X402_FACILITATOR_EVM_PRIVATE_KEY
X402_PAY_TO
X402_NETWORK=eip155:8453
X402_ASSET=0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913

Bootstrap Response Fields

Successful bootstrap responses include team_id, api_key, endpoint, endpoint_with_token, hook_token, wallet_balance_atomic, network, and asset.

Security note: bootstrap credentials are only available for a short replay window after first issuance. Store them immediately.

Payload Output Modes

`kite stream` (default) prints concise summary lines.
`kite stream --compact` prints summary-only one-liners.
`kite stream --json` prints full CloudEvent payload JSON.

kite

Universal webhook adapter CLI

Usage: kite [OPTIONS] [COMMAND]

Commands:
  stream     Stream webhook events to stdout
  proxy      Proxy webhook events to a local HTTP server
  listen     Listen for events via Unix socket or exec
  run        Run with a kite.json manifest
  retry      Retry failed events from the dead letter queue
  login      Log in to Kite via device auth flow
  github     Install GitHub webhooks into repositories using local gh auth
  endpoints  Manage webhook endpoints
  keys       Manage API keys
  skill      Install and inspect agent skills
  logs       View persisted event logs
  status     Show dashboard-equivalent status summary
  update     Update the installed kite binary
  queue      Inspect and manage the local event queue
  help       Print this message or the help of the given subcommand(s)

Options:
      --install-skill <NAME>  Compatibility shortcut for `kite skill install <NAME>`
  -h, --help                  Print help
  -V, --version               Print version

Quick Reference:
  stream               --source --event-type --json --compact
  proxy                --source --target --route
  listen               --socket --source
  run                  --manifest
  retry                --source --target
  github install       --repo --events --all-events --rotate-secret
  login                --server
  endpoints create     --source
  endpoints deactivate --id
  keys create          --name --scopes --permissions --expires-at
  keys revoke          --id
  skill install        <name>
  skill list
  logs                 --limit
  update               --check --force --server

Use `kite stream --json` to print full CloudEvent payloads.
Use `kite <command> --help` for complete options.

kite stream

Stream webhook events to stdout

Usage: kite stream [OPTIONS]

Options:
      --source <SOURCE>           Filter by source (e.g. "github", "stripe")
      --event-type <type>         Filter by event type
      --json                      Output full CloudEvent JSON per line
      --compact                   Output compact one-line summaries only
      --exec <EXEC>               Execute a command for each event, passing event JSON on stdin
      --client-id <CLIENT_ID>     Persistent client ID for delivery cursor tracking
      --importance <IMPORTANCE>   Minimum importance level to deliver (low, normal, high, critical)
      --federation-target <URL>   Forward received events to another Kite instance (P2P federation). Value: full hook URL e.g. https://kite.example.com/hooks/<team_id>/kite NOTE: for production use, prefer server-side federation (--help for details)
      --federation-token <TOKEN>  Bearer token for authenticating with the federation target
      --instance-id <ID>          This instance's stable identifier for federation provenance tracking (defaults to a random UUID if not set)
  -h, --help                      Print help
  -V, --version                   Print version

kite proxy

Proxy webhook events to a local HTTP server

Usage: kite proxy [OPTIONS]

Options:
      --source <SOURCE>        Filter by source (e.g. "github", "stripe")
      --target <TARGET>        Default target URL to forward events to
      --route <SOURCE=TARGET>  Source-specific route in the form <source>=<target> (repeatable)
      --client-id <CLIENT_ID>  Persistent client ID for delivery cursor tracking
  -h, --help                   Print help
  -V, --version                Print version

Examples:
  # Single target mode: all sources -> one local endpoint
  kite proxy --target http://localhost:3000/webhooks

  # Multi-route mode with fallback/default target
  kite proxy --route github=http://localhost:3001/github \
             --route stripe=http://localhost:3002/stripe \
             --target http://localhost:3000/default

  # Route-only mode (no fallback): errors + DLQ when source has no explicit route
  kite proxy --route github=http://localhost:3001/github

  # Downstream router mode: keep one local endpoint and dispatch by headers
  kite proxy --target http://localhost:3000/kite/router
  # Forwarded metadata headers include:
  #   x-kite-source, x-kite-event-id, x-kite-event-type, x-kite-team-id
  #   ce-id, ce-source, ce-type, ce-specversion, ce-time (if present)

Notes:
  Existing Kite webhook endpoints do not need to be recreated to use routes.
  --route keys are matched by source name (derived from event type, e.g. com.github.push -> github).

kite listen

Listen for events via Unix socket or exec

Usage: kite listen [OPTIONS]

Options:
      --socket <SOCKET>  Unix socket path to create
      --source <SOURCE>  Filter by source
  -h, --help             Print help
  -V, --version          Print version

kite run

Run with a kite.json manifest

Usage: kite run --manifest <MANIFEST>

Options:
      --manifest <MANIFEST>  Path to kite.json manifest file
  -h, --help                 Print help
  -V, --version              Print version

kite retry

Retry failed events from the dead letter queue

Usage: kite retry [OPTIONS] --target <TARGET>

Options:
      --source <SOURCE>  Only retry events from this source
      --target <TARGET>  Target URL for retried events
  -h, --help             Print help
  -V, --version          Print version

kite login

Log in to Kite via device auth flow

Usage: kite login [OPTIONS]

Options:
      --server <SERVER>  Server URL [default: https://getkite.sh]
  -h, --help             Print help
  -V, --version          Print version

kite github

Install GitHub webhooks into repositories using local gh auth

Usage: kite github <COMMAND>

Commands:
  install  Create or update a GitHub repository webhook that points at Kite
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite github install

Create or update a GitHub repository webhook that points at Kite

Usage: kite github install [OPTIONS] --repo <REPO>

Options:
      --repo <REPO>      Repository in OWNER/REPO format
      --events <EVENTS>  Comma-separated GitHub event names that replace the default bundle
      --all-events       Subscribe the webhook to all GitHub events
      --rotate-secret    Rotate the stored GitHub webhook secret while reinstalling
  -h, --help             Print help
  -V, --version          Print version

Examples:
  # Install the default agent-focused GitHub event bundle
  kite github install --repo owner/repo

  # Replace defaults with an explicit event list
  kite github install --repo owner/repo --events push,pull_request

  # Subscribe to every GitHub event
  kite github install --repo owner/repo --all-events

  # Rotate the stored GitHub secret while reinstalling the hook
  kite github install --repo owner/repo --rotate-secret

Default events:
  push,pull_request,issues,issue_comment,pull_request_review,pull_request_review_comment

Notes:
  --events replaces the default bundle entirely.
  --all-events is mutually exclusive with --events.
  This command uses your local `gh` authentication and updates the GitHub webhook in-place when rerun.

kite endpoints

Manage webhook endpoints

Usage: kite endpoints <COMMAND>

Commands:
  list        List endpoints
  create      Create or rotate endpoint credentials for a source (GitHub includes a one-time webhook secret)
  deactivate  Deactivate endpoint by id
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite endpoints list

List endpoints

Usage: kite endpoints list

Options:
  -h, --help     Print help
  -V, --version  Print version

kite endpoints create

Create or rotate endpoint credentials for a source (GitHub includes a one-time webhook secret)

Usage: kite endpoints create [OPTIONS] --source <SOURCE>

Options:
      --source <SOURCE>              Source name (e.g. github, stripe)
      --repo <REPO>                  GitHub repo (owner/name) — auto-registers webhook via GitHub API
      --events <EVENTS>              Webhook events to subscribe to (comma-separated, default: push,pull_request,issues)
      --force                        Replace existing webhook on the repo
      --github-token <GITHUB_TOKEN>  GitHub personal access token (falls back to GITHUB_TOKEN env or gh CLI)
  -h, --help                         Print help
  -V, --version                      Print version

kite endpoints deactivate

Deactivate endpoint by id

Usage: kite endpoints deactivate --id <ID>

Options:
      --id <ID>  Endpoint id
  -h, --help     Print help
  -V, --version  Print version

kite keys

Manage API keys

Usage: kite keys <COMMAND>

Commands:
  list    List API keys
  create  Create a new API key
  revoke  Revoke API key by id
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite keys list

List API keys

Usage: kite keys list

Options:
  -h, --help     Print help
  -V, --version  Print version

kite keys create

Create a new API key

Usage: kite keys create [OPTIONS]

Options:
      --name <NAME>                Optional key name
      --scopes <SCOPES>            Comma-separated scopes
      --permissions <PERMISSIONS>  Comma-separated permissions
      --expires-at <EXPIRES_AT>    Optional RFC3339 expiry timestamp
  -h, --help                       Print help
  -V, --version                    Print version

kite keys revoke

Revoke API key by id

Usage: kite keys revoke --id <ID>

Options:
      --id <ID>  Key id
  -h, --help     Print help
  -V, --version  Print version

kite skill

Install and inspect agent skills

Usage: kite skill <COMMAND>

Commands:
  install           Install a skill from the default registry
  list              List installed skills
  export            Export the kite SKILL.md to agent skill directories
  publish           Publish a skill to the central registry
  search            Search for skills in the registry
  registry-install  Install a skill from the remote registry by ID
  help              Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite skill install

Install a skill from the default registry

Usage: kite skill install <NAME>

Arguments:
  <NAME>  Skill name (e.g. weather, github)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite skill list

List installed skills

Usage: kite skill list

Options:
  -h, --help     Print help
  -V, --version  Print version

kite skill publish

Publish a skill to the central registry

Usage: kite skill publish [OPTIONS] --name <NAME> --version <VERSION>

Options:
      --name <NAME>                Skill name (alphanumeric, hyphens, underscores, dots)
      --version <VERSION>          Semver version string (e.g. "1.0.0")
      --description <DESCRIPTION>  Short description of the skill
      --content <CONTENT>          Skill content (reads SKILL.md from current directory if omitted)
      --public                     Make the skill publicly discoverable
  -h, --help                       Print help

kite skill search

Search for skills in the registry

Usage: kite skill search [QUERY]

Arguments:
  [QUERY]  Search query (matches name and description)

Options:
  -h, --help     Print help
  -V, --version  Print version

kite skill registry-install

Install a skill from the remote registry by ID

Usage: kite skill registry-install [OPTIONS] --skill-id <SKILL_ID>

Options:
      --skill-id <SKILL_ID>      Skill ID (UUID) to install
      --version-id <VERSION_ID>  Specific version ID to install (latest if omitted)
  -h, --help                     Print help
  -V, --version                  Print version

kite logs

View persisted event logs

Usage: kite logs [OPTIONS]

Options:
      --limit <LIMIT>  Number of events to fetch [default: 100]
  -h, --help           Print help
  -V, --version        Print version

kite status

Show dashboard-equivalent status summary

Usage: kite status

Options:
  -h, --help     Print help
  -V, --version  Print version

kite update

Update the installed kite binary

Usage: kite update [OPTIONS]

Options:
      --check            Check whether an update is available without installing it
      --force            Force reinstall even if current version is up to date
      --server <SERVER>  Override update server base URL
  -h, --help             Print help
  -V, --version          Print version