kagi-cli

# kagi CLI

> Complete documentation for the `kagi` CLI, a Rust-based command-line interface for Kagi search, automation, and structured terminal workflows.

## Guides

- [Introduction](https://kagi.micr.dev/): Complete guide to the *kagi* CLI - a command-line interface for Kagi search, automation, and structured terminal workflows.
- [Installation](https://kagi.micr.dev/guides/installation): Complete installation guide for *kagi* CLI on macOS, Linux, and Windows including package managers, manual installation, and troubleshooting.
- [Quickstart](https://kagi.micr.dev/guides/quickstart): Get up and running with *kagi* CLI in minutes - from your first unauthenticated command to full subscriber workflows.
- [Authentication](https://kagi.micr.dev/guides/authentication): Complete guide to understanding *kagi* CLI authentication - session tokens, API tokens, precedence rules, and security best practices.
- [Common Workflows](https://kagi.micr.dev/guides/workflows): Practical task-oriented examples for *kagi* CLI - from daily automation to complex research pipelines.
- [Advanced Usage](https://kagi.micr.dev/guides/advanced-usage): Advanced patterns for scripting, automation, CI/CD integration, and building with *kagi* CLI.
- [Troubleshooting](https://kagi.micr.dev/guides/troubleshooting): Common issues, error messages, debugging techniques, and solutions for *kagi* CLI problems.

## Core Commands

- [search](https://kagi.micr.dev/commands/search): Complete reference for *kagi* search command - syntax, flags, authentication, output formats, and real-world examples.
- [batch](https://kagi.micr.dev/commands/batch): Run multiple Kagi searches in parallel, including stdin-fed query batches.
- [auth](https://kagi.micr.dev/commands/auth): Complete reference for *kagi* auth command - credential management, validation, and configuration.
- [usage](https://kagi.micr.dev/commands/usage): Inspect the current plan, AI cost allowance, account balance, renewal date, and calendar-month usage.
- [summarize](https://kagi.micr.dev/commands/summarize): Complete reference for *kagi* summarize command - summarize URLs and text using subscriber or public API modes.
- [extract](https://kagi.micr.dev/commands/extract): Fetch a page's full content as markdown using Kagi's Extract API.
- [watch](https://kagi.micr.dev/commands/watch): Monitor a Kagi search query and emit result diffs.
- [notify](https://kagi.micr.dev/commands/notify): Send Kagi search or news output to a webhook.
- [history](https://kagi.micr.dev/commands/history): Inspect local kagi-cli command history and query stats.
- [skills](https://kagi.micr.dev/commands/skills): Embedded, version-matched guidance for agents and automation.
- [mcp](https://kagi.micr.dev/commands/mcp): Run kagi-cli as a stdio Model Context Protocol server.
- [completion](https://kagi.micr.dev/commands/completion): Complete reference for *kagi* completion command - generate and install shell completion scripts.

## Content and Feeds

- [news](https://kagi.micr.dev/commands/news): Complete reference for *kagi* news command - fetch Kagi News from public JSON endpoints with category filtering.
- [smallweb](https://kagi.micr.dev/commands/smallweb): Complete reference for *kagi* smallweb command - fetch the Kagi Small Web feed of independent websites.

## AI and Enrichment

- [assistant](https://kagi.micr.dev/commands/assistant): Complete reference for *kagi* assistant command - interact with Kagi AI Assistant programmatically.
- [quick](https://kagi.micr.dev/commands/quick): Complete reference for *kagi* quick command - get Kagi Quick Answer responses with references from the terminal.
- [ask-page](https://kagi.micr.dev/commands/ask-page): Complete reference for *kagi* ask-page command - ask Kagi Assistant about a specific web page.
- [translate](https://kagi.micr.dev/commands/translate): Translate text through Kagi Translate with session-token auth.
- [fastgpt](https://kagi.micr.dev/commands/fastgpt): Complete reference for *kagi* fastgpt command - get quick answers using Kagi's FastGPT API.
- [enrich](https://kagi.micr.dev/commands/enrich): Complete reference for *kagi* enrich command - query Kagi's enrichment indexes for web and news.

## Settings

- [lens](https://kagi.micr.dev/commands/lens): Complete reference for *kagi* lens command - manage search lenses from the terminal.
- [bang](https://kagi.micr.dev/commands/bang): Complete reference for *kagi* bang command - manage custom bangs from the terminal.
- [redirect](https://kagi.micr.dev/commands/redirect): Complete reference for *kagi* redirect command - manage redirect rules from the terminal.
- [site-pref](https://kagi.micr.dev/commands/site-pref): Manage local domain preferences applied to CLI search output.

## Reference

- [Auth Matrix](https://kagi.micr.dev/reference/auth-matrix): Complete matrix showing which commands require which authentication tokens and how fallback works.
- [Output Contract](https://kagi.micr.dev/reference/output-contract): Complete specification of *kagi* CLI output formats - JSON schemas, pretty mode, and error handling.
- [Error Reference](https://kagi.micr.dev/reference/error-reference): Complete catalog of error messages, their meanings, and solutions.
- [API and Product Coverage](https://kagi.micr.dev/reference/coverage): Complete reference of what APIs and product features are implemented today and what is intentionally unavailable.

## Project

- [Development](https://kagi.micr.dev/project/development): Build, test, and maintain *kagi* from a source checkout.
- [Demos](https://kagi.micr.dev/project/demos): Recorded terminal demos and how to regenerate them.
- [Support and Contribution](https://kagi.micr.dev/project/support): Where to file issues, how to contribute safely, and what not to commit.
- [Contributing](https://kagi.micr.dev/project/contributing): How to contribute to *kagi* CLI - bug reports, feature requests, documentation improvements, and code contributions.