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
{{ message }}
Repository navigation
Commit 6152d44
Browse filesBrowse the repository at this point in the historyBrowse files
-`--all-pages` — Fetch all result pages and merge array fields across pages
63
63
-`--max-pages <n>` — Maximum number of pages to fetch when using `--all-pages`
@@ -103,7 +103,7 @@ Interactive authentication flow to save API key to config file.
103
103
serpapi login
104
104
```
105
105
106
-
## Global Flags
106
+
## Global flags
107
107
108
108
-`--fields <expr>` — Server-side field filtering (maps to SerpApi's `json_restrictor` parameter). Note: The `--fields` filter uses SerpApi's server-side field restrictor syntax—see [SerpApi docs](https://serpapi.com) for supported expressions.
109
109
-`--jq <expr>` — Client-side [jq](https://jqlang.github.io/jq/) filter applied to the JSON response, same as `gh --jq` (see the [jq tutorial](https://jqlang.github.io/jq/tutorial/) for syntax). Runs locally after the API call; the jq engine is embedded so no external `jq` install is required. Use `--fields` to shrink the payload server-side, then `--jq` to reshape it client-side. Examples:
@@ -130,7 +130,7 @@ serpapi login
130
130
131
131
## Configuration
132
132
133
-
### Authentication Priority Chain
133
+
### Authentication priority chain
134
134
135
135
The CLI checks for API keys in this order:
136
136
@@ -143,13 +143,13 @@ If no API key is found, run `serpapi login` to authenticate interactively.
143
143
> **Security note:** For security, prefer setting `SERPAPI_KEY` as an environment variable over
144
144
> passing `--api-key` on the command line (command-line arguments are visible in process listings).
145
145
146
-
### Config File Format
146
+
### Config file format
147
147
148
148
```toml
149
149
api_key = "your_serpapi_key_here"
150
150
```
151
151
152
-
## For AI Agents
152
+
## For AI agents
153
153
154
154
This CLI is optimized for consumption by AI agents (Claude, Codex, etc.):
0 commit comments