The official command-line interface and full-screen terminal workspace for Zerodha Kite. Monitor live market data, analyse charts and option chains, manage your portfolio, and place orders directly from your terminal or shell scripts.
Releases · Installation · User Guide · CLI Reference · Screenshots
- Live market data — Stream real-time quotes, indices, 5-level market depth, and top market movers across your Kite watchlists or custom instrument lists.
- Order execution & safety — Place, modify, and cancel orders, GTT triggers, and price alerts (including alert-to-order baskets). Trading commands preview requests before submission unless
--confirmis passed. - Portfolio & funds — Track holdings, net and day positions, real-time profit and loss, and available margins.
- Charts & technicals — Read interactive candlestick charts with volume, multiple intervals, and built-in overlays and indicators (SMA, EMA, Bollinger Bands, RSI, MACD).
- Option chains — Inspect live option chains with open interest, expiry selection, and a side-by-side chart of the underlying instrument.
- IPOs & bids — Browse open IPOs, government securities, auctions, and corporate actions, then open one on Kite Web to apply. Mutual fund holdings sit in Portfolio, and
kite mfcovers SIPs and fund orders. - Six customizable workspaces — Switch workspaces with
1–6, resize or maximise panes, search instruments via the command palette, keep local trading notes, and choose from 22 built-in themes with live preview (T). - Scriptable CLI — Query quotes, historical candles, orders, and portfolio data from standard UNIX pipelines with structured
--jsonoutput.
Install the prebuilt binary on Linux and macOS (x86_64 and aarch64 / Apple Silicon):
curl -fsSL https://raw.githubusercontent.com/zerodha/kite-cli/main/scripts/install.sh | shThe installer detects your platform and verifies the archive's SHA-256 checksum before extracting kite.
Install on Windows x86_64 with PowerShell:
irm https://raw.githubusercontent.com/zerodha/kite-cli/main/scripts/install.ps1 | iexSee Installation for manual archive downloads, custom install paths (KITE_INSTALL_DIR), and verification details.
1. Launch the terminal workspace
kiteIf you aren't signed in yet, kite opens an interactive sign-in screen for your Kite user ID, password, and 2FA code before loading your workspace. Press ? inside the UI to view keyboard shortcuts, 1–6 to switch workspaces, or T to change themes.
2. Or use the CLI from your shell
If you are running CLI commands directly without opening the TUI, sign in from the terminal first (the TUI and CLI share the same session):
kite auth login # Sign in from the shell (use `kite doctor` to verify)
kite portfolio holdings # Holdings and overall P&L
kite portfolio positions # Net and day positions
kite orders list # Today's order book
kite user margins # Available and utilised funds
kite alerts list # Active price alerts
kite market quote NSE:INFY # Live quote and market depthPass --json to any command for machine-readable output in scripts and pipelines, or --help to inspect available flags. See Orders and Scripting for examples.
| Guide | Description |
|---|---|
| Getting started | First-time setup, login, session checks, and basic workflows |
| Terminal UI guide | Workspaces, watchlists, order tickets, charts, and keybindings |
| User guide | Detailed guides for orders, portfolio, market data, alerts, and mutual funds |
| CLI reference | Complete reference for all commands, subcommands, and flags |
| Screenshots | Full-resolution captures of all six workspaces and the theme picker |
| Troubleshooting | Solutions for session errors, rate limits, and terminal display issues |
The CLI uses kiteconnect, a standalone typed Rust client for the Kite Connect v3 REST and WebSocket API.
To build kite from source, run the test suite, or contribute changes, see CONTRIBUTING.md.
Licensed under the MIT License.