You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-4Lines changed: 33 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@
16
16
17
17
---
18
18
19
-
`kagi` is a terminal CLI for Kagi that gives you command-line access to search, quick answers, ask-page, assistant, translate, summarization, feeds, paid API commands, and account-level settings like lenses, custom assistants, custom bangs, and redirect rules. it is built for people who want one command surface for interactive use, shell workflows, and structured JSON output.
19
+
`kagi` is a terminal CLI for Kagi that gives you command-line access to search, quick answers, ask-page, assistant, translate, summarization, public feeds through `news` and `smallweb`, paid API commands like `fastgpt` and `enrich`, and account-level settings like lenses, custom assistants, custom bangs, and redirect rules. it is built for people who want one command surface for interactive use, shell workflows, and structured JSON output.
20
20
21
21
the main setup path is `kagi auth`. on a real terminal it opens a guided setup flow where you choose `Session Link` or `API Token`, get the official instructions inline, paste the credential, save it to `./.kagi.toml`, and validate it immediately. if you also use Kagi's paid API, the same wizard can add that too.
22
22
@@ -30,7 +30,7 @@ if you already use Kagi and want to access it from scripts, shell workflows, or
30
30
31
31
- use your existing session-link URL for subscriber features
32
32
- get structured JSON for scripts, agents, and other tooling
33
-
- use one CLI for search, quick answers, assistant, translate, summarization, and feeds
33
+
- use one CLI for search, quick answers, assistant, translate, summarization, `news`, and `smallweb`
34
34
- add `KAGI_API_TOKEN` only when you want the paid public API commands
35
35
36
36
## quickstart
@@ -155,7 +155,7 @@ for the full command-to-token matrix, use the [`auth-matrix`](https://kagi.micr.
155
155
156
156
| command | purpose |
157
157
| --- | --- |
158
-
|`kagi search`| search Kagi with JSON by default, optional live filters, or `--format pretty` for terminal output|
158
+
|`kagi search`| search Kagi with `json` by default, or render as `pretty`, `compact`, `markdown`, or `csv`|
159
159
|`kagi batch`| run multiple searches in parallel with JSON, compact, pretty, markdown, or csv output and shared filters |
160
160
|`kagi auth`| launch the auth wizard, or inspect, validate, and save credentials |
161
161
|`kagi summarize`| use the paid public summarizer API or the subscriber summarizer with `--subscriber`|
if you want a quick feel for the cli before installing it, this is the kind of output you get from auth setup, quick answer, translate, ask-page, the subscriber summarizer, assistant, and the public news feed:
0 commit comments