Kite CLI

Build, test, inspect, and deploy Customer Success as Code from your terminal.

What is Kite?

Kite is an event-driven Customer Success as Code engine. Instead of hiding activation, lifecycle, customer health, and churn-risk logic in a vendor UI, Kite lets you define them as versioned, reviewable TypeScript.

Kite combines three layers:

• Configuration: definitions for lifecycle states, journeys, rules, segments, health scores, and signals.
• Product events: customer activity sent from your application.
• State engine: deterministic, explainable customer state computed from your definitions and event history.

The CLI is the primary interface for creating a Kite project, running the engine locally, inspecting its decisions, and deploying configuration to Kite Cloud.

Install

Kite requires Node.js 20 or newer.

npm install --global @kitesdk/cli
kite --help

Authenticate

kite auth login
kite whoami

The CLI connects to https://api.usekite.cloud by default. Set KITE_API_URL only when using a self-hosted or local API.

Configuration workflow

kite init
kite validate
kite dev
kite deploy --env test
kite config versions --env test
kite config diff
kite config diff v1 v2
kite config rollback --env test --version v1
kite config pull --env test

config pull writes the remote snapshot to .kite/pulled-config.json. It does not overwrite the TypeScript DSL because compiled JSON cannot be safely converted back to authored source files.

Core workflow

Treat customer-success configuration like application code:

edit -> validate -> test locally -> review diff -> deploy

Use kite dev to process events locally, then inspect the resulting customer state before deploying to the isolated test or live environment.

Automation

Headless CI can set KITE_ACCESS_TOKEN and KITE_ORGANIZATION. Keep both in the CI provider's secret store.

Resources

• Kite website
• Documentation
• CLI reference
• Support

Run kite <command> --help for current options.

License and terms

This package is provided under the Kite Software License. Use of Kite Cloud and related services is also governed by the Kite Terms of Service.