kite~/kite/docs/Deployment
v0.2.2
Documentation

Deploying Kite

Run the Kite CLI in production from a verified release archive, a container you build, or CI.

Running the CLI in production

The kite release archive contains a prebuilt executable. Verify its SHA-256 sidecar before copying it into an environment. Published binaries currently target macOS arm64 and glibc-based Linux x86_64.

bash
# In a Dockerfile
COPY kite /usr/local/bin/kite

# Or install via the checksum-verifying script at build time
RUN curl -fsSL https://getkite.sh/install | sh

Environment variables

VariableDescription
KITE_API_KEYAPI key; overrides the config file
KITE_TEAM_IDTeam identifier; overrides the config file
KITE_WS_URLWebSocket relay URL (hosted service: wss://api.getkite.sh/ws)
KITE_HOOK_BASE_URLOptional HTTP hook/API base override

Set KITE_API_KEY in your CI secrets or container environment instead of using the device auth flow.

Container image built from a verified binary

Kite does not currently publish a public container image. Build your own image from a verified Linux x86_64 release artifact:

dockerfile
FROM debian:bookworm-slim

RUN curl -fsSL https://getkite.sh/install | sh

ENV KITE_API_KEY=your_key_here

CMD ["kite", "proxy", "--source", "github", "--target", "http://app:3000/webhooks"]

CI/CD integration

Use Kite in GitHub Actions to receive webhook events during test runs:

yaml
- name: Start Kite proxy
  env:
    KITE_API_KEY: ${{ secrets.KITE_API_KEY }}
  run: |
    kite proxy --source github --target http://localhost:3000/webhooks &
    echo "KITE_PID=$!" >> $GITHUB_ENV