Command-line interface for Search1API — web search, news, crawl, sitemap, and trending from your terminal.
curl -fsSL https://cli.search1api.com/install.sh | bashThis downloads a standalone binary and installs it as s1.
npm install -g search1api-cliThis installs two commands: search1api and s1 (shorthand).
s1 updates1 update updates you in place using whichever method you installed with:
- Binary install — downloads the latest release for your platform and replaces the running binary (uses
sudoautomatically if needed). - npm install — prints the
npm install -g search1api-clicommand to run.
s1 also checks for new versions in the background and shows a notice when one is available.
Authorize the CLI with OAuth 2.1 in your browser. The CLI dynamically registers as a public client, uses Authorization Code with PKCE, and refreshes access tokens automatically:
s1 loginManual fallback:
s1 config set-key <your-api-key>Or use an environment variable:
export SEARCH1API_KEY=<your-api-key>Search the web across 13 search engines.
s1 search "Claude AI"
s1 search "rust async" -n 5 -s google
s1 search "machine learning" --include arxiv.org github.com
s1 search "breaking news" -t day
s1 search "web framework" -c 3 # crawl top 3 results for full content| Option | Description | Default |
|---|---|---|
-n, --max-results <number> |
Number of results (1-50) | 10 |
-s, --service <service> |
Search engine | |
-c, --crawl <number> |
Crawl N results for full content | 0 |
--include <sites...> |
Only include these sites | |
--exclude <sites...> |
Exclude these sites | |
-t, --time <range> |
Time range: day, month, year |
|
--json |
Output raw JSON |
Available search services: google, bing, duckduckgo, yahoo, x, reddit, github, youtube, arxiv, wechat, bilibili, imdb, wikipedia
Search for news articles.
s1 news "AI regulation"
s1 news "tech layoffs" -s hackernews -t day| Option | Description | Default |
|---|---|---|
-n, --max-results <number> |
Number of results (1-50) | 10 |
-s, --service <service> |
News service | bing |
-c, --crawl <number> |
Crawl N results for full content | 0 |
--include <sites...> |
Only include these sites | |
--exclude <sites...> |
Exclude these sites | |
-t, --time <range> |
Time range: day, month, year |
|
--json |
Output raw JSON |
Available news services: google, bing, duckduckgo, yahoo, hackernews
Extract content from a URL.
s1 crawl https://example.com/articleGet related links from a website.
s1 sitemap https://example.comGet trending topics from popular platforms.
s1 trending github
s1 trending hackernews -n 20Available services: github, hackernews
Check your remaining API credits.
s1 balanceAuthorize in your browser with OAuth 2.1 and PKCE.
s1 login
s1 login --no-browserManage CLI configuration.
s1 config set-key <key> # Save API key manually
s1 config show # Show current config
s1 config clear # Remove saved OAuth tokens and API keysUpdate s1 to the latest version. See Updating.
s1 update
s1 update --force # reinstall even if already on the latest versionPlugin and integration packages can reuse the CLI's authentication, OAuth refresh, request handling, and typed Search1API methods instead of maintaining a second client:
import { search, crawl } from "search1api-cli/sdk";
const results = await search("OpenCode plugins", {
maxResults: 5,
searchService: "github",
});
const page = await crawl("https://example.com");The SDK uses SEARCH1API_KEY, the shared s1 login OAuth session, or the
optional per-call apiKey. Every method also accepts an AbortSignal so host
applications can cancel tool calls.
This repo is the shared distribution point for the Search1API Agent Skill and compatibility manifests for Claude Code, ChatGPT/Codex, and Cursor. Dedicated OpenCode, OpenClaw, and Grok Build plugins reuse the same Search1API SDK, hosted MCP server, and research workflow from their own repositories.
Install the standalone skill:
npx skills add superagents-lab/search1api-cliInstall the Claude Code plugin from Search1API's custom marketplace:
claude plugin marketplace add superagents-lab/search1api-cli
claude plugin install search1api@superagents-labAdd this repository as a Codex marketplace, then install the plugin:
codex plugin marketplace add superagents-lab/search1api-cli
codex plugin add search1api@superagents-labInstall the dedicated
grok-search1api
plugin directly from GitHub:
agent plugin install superagents-lab/grok-search1api --trustThe same repository can also be added as a custom Grok marketplace:
agent plugin marketplace add superagents-lab/grok-search1apiInstall the dedicated OpenCode plugin from npm:
opencode plugin opencode-search1apiInstall the dedicated OpenClaw plugin from ClawHub:
openclaw plugins install clawhub:@fatwang2/openclaw-search1apiSee the source repositories for platform-specific configuration and release details:
Developers can validate or test the plugin bundle from a local clone:
claude plugin validate . --strict
claude --plugin-dir .The remote server is also published as
io.github.superagents-lab/search1api
in the official MCP Registry. Directory reviewers can use the
submission kit for verified URLs, listing copy,
authentication details, use cases, and test cases. The Cursor manifest in this
repository is available for local or team testing; public Cursor Marketplace
availability is a separate review process.
Once installed, you can ask the host agent things like:
- "search for the latest AI news"
- "what does this link say? https://example.com"
- "what's trending on GitHub?"
- "research quantum computing thoroughly"
The plugin uses the hosted Search1API MCP tools and the shared research skill;
the s1 CLI remains available as a fallback where supported.
All commands support --json flag to output raw JSON, useful for piping and scripting:
s1 search "test" --json | jq '.results[0].title'
s1 balance --jsonMIT