Skip to content

Commit 6152d44

Browse files
Fix formatting issues in README.md
1 parent 12abc1f commit 6152d44

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# serpapi-cli
22

3-
> HTTP client for structured web search data via SerpApi
3+
HTTP client for structured web search data via SerpApi
44

55
## Installation
66

@@ -11,7 +11,7 @@ brew tap serpapi/homebrew-tap
1111
brew install serpapi-cli
1212
```
1313

14-
### Pre-built Binaries
14+
### Pre-built binaries
1515

1616
Download directly from [GitHub Releases](https://github.com/serpapi/serpapi-cli/releases)
1717

@@ -21,7 +21,7 @@ Download directly from [GitHub Releases](https://github.com/serpapi/serpapi-cli/
2121
go install github.com/serpapi/serpapi-cli/cmd/serpapi@latest
2222
```
2323

24-
## Quick Start
24+
## Quick start
2525

2626
```bash
2727
# Authenticate
@@ -57,7 +57,7 @@ serpapi search --jq ".organic_results[0:3] | [.[] | {title, link}]" engine=googl
5757
serpapi search --fields "organic_results" --jq ".organic_results[0:3] | [.[] | {title, link}]" engine=google q=coffee
5858
```
5959

60-
#### Pagination Flags
60+
#### Pagination flags
6161

6262
- `--all-pages` — Fetch all result pages and merge array fields across pages
6363
- `--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.
103103
serpapi login
104104
```
105105

106-
## Global Flags
106+
## Global flags
107107

108108
- `--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.
109109
- `--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
130130

131131
## Configuration
132132

133-
### Authentication Priority Chain
133+
### Authentication priority chain
134134

135135
The CLI checks for API keys in this order:
136136

@@ -143,13 +143,13 @@ If no API key is found, run `serpapi login` to authenticate interactively.
143143
> **Security note:** For security, prefer setting `SERPAPI_KEY` as an environment variable over
144144
> passing `--api-key` on the command line (command-line arguments are visible in process listings).
145145
146-
### Config File Format
146+
### Config file format
147147

148148
```toml
149149
api_key = "your_serpapi_key_here"
150150
```
151151

152-
## For AI Agents
152+
## For AI agents
153153

154154
This CLI is optimized for consumption by AI agents (Claude, Codex, etc.):
155155

0 commit comments

Comments
 (0)