Kite CLI

Kite CLIDhan CLI

A cross-platform .NET 10 command-line client for the Zerodha Kite Connect v3 API. Binary name: kite.

The Kite CLI wraps auth, profile, portfolio, orders, trades, GTT triggers, alerts, the instrument master, quotes, historical candles, mutual-fund reads, and margin/charges calculators in a single self-contained binary.

Quick start

# 1. Configure app credentials (one-time)
kite auth configure --api-key <api_key> --api-secret <api_secret> --json --no-color

# 2. Daily browser login (Kite sessions expire every day)
kite auth login --json --no-color

# 3. Verify you have a session
kite auth status --json --no-color

# 4. Inspect today's trading
kite orders list --json --no-color
kite trades list --json --no-color
kite portfolio positions --json --no-color

# 5. Resolve a trading symbol to an instrument token for historical candles
kite instruments download --exchange NSE --json --no-color
kite instruments search INFY --exchange NSE --json --no-color

Reference by command group

auth

App credentials, browser-login, request token exchange, logout.

config

Non-secret preferences (config.json).

user

Profile and segment margins.

portfolio

Holdings, positions, auctions, holdings authorisation, position conversion.

orders

Place / modify / cancel / list today’s orders. Live action

trades

Today’s tradebook.

gtt

Good-till-triggered orders. Live action

alerts

Price/action alerts. Live action

instruments

Download and search the Kite instrument master.

quote

LTP / OHLC / full quotes — exchange-prefixed symbols.

historical

Historical candles — numeric instrument token.

mutual-funds

MF instruments / holdings / orders / SIPs (read-only — no placement via API).

margins

Order and basket margin calculator.

charges

Virtual contract-note charge calculator.

update

Print the latest release URL.

See also

• Install — one-line install on macOS / Linux / Windows.
• Concepts — the --json / --no-color contract, exit codes, secret store.
• Security — no telemetry, OS keyring only, transcript hygiene.
• Terminal agent guide — operating rules for agents driving the CLI.