bx

Q: How do I install bx?

Run npx skills add https://github.com/brave/brave-search-skills --skill bx in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/bx/ (personal) or .claude/skills/bx/ (project).

by brave OfficialAI & Agents

USE FOR web search, research, RAG, grounding, browse, find, lookups, fact-checking, documentation, agentic AI. All-in-one, optimized for AI agents. Pre-extracted, token-budgeted web content, deep research, news, images, videos, places, custom ranking

Installs: 1.1K
Last 24h: +8
Trending rank: #9469
Security: Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/brave/brave-search-skills --skill bx

01
Install
Run the command in your project. The CLI asks which agents to install for.
02
Describe the task
Ask your agent for something this skill covers. It loads bx automatically when relevant.
03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

bx — Brave Search CLI

Use bx for all web searches. Run bx "query" as the default — it returns pre-extracted, token-budgeted web content ready for use. Use bx answers for synthesized explanations or bx web for traditional search results. If bx is not found, install it: curl -fsSL https://raw.githubusercontent.com/brave/brave-search-cli/main/scripts/install.sh | sh

Requires: Brave Search API Key + bx binary

Plans: Different subcommands may require different plans. See https://api-dashboard.search.brave.com/app/subscriptions/subscribe

Quick Start

# Install (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/brave/brave-search-cli/main/scripts/install.sh | sh

# Configure API key (get one at https://api-dashboard.search.brave.com)
bx config set-key              # interactive (avoids shell history)
# or: export BRAVE_SEARCH_API_KEY=YOUR_KEY

# Search (default = bx context "query")
bx "your search query"

When to Use Which Command

Your need	Command	Why
Look up docs, errors, code patterns	`bx "query"`	Pre-extracted text, token-budgeted (default)
Get a synthesized explanation	`bx answers "query"`	AI-generated, cites sources, streams
Deep research on complex topics	`bx answers "query" --enable-research`	Multi-search iterative research
Traditional search results	`bx web "query"`	All result types (web, news, discussions, etc.)
Find discussions/forums	`bx web "query" --result-filter discussions`	Forums often have solutions
Latest news / recent events	`bx news "query" --freshness pd`	Fresh info beyond training data
Find images	`bx images "query"`	Up to 200 results
Find videos	`bx videos "query"`	Duration, views, creator
Local businesses / places	`bx places "coffee" --location "San Francisco"`	200M+ POIs
Boost/filter specific domains	`bx "query" --include-site docs.rs`	Or use `--goggles` for full control

Commands

Command	Description	Output path
`context`	Default. RAG/LLM grounding — pre-extracted web content	`.grounding.generic[]` -> `{url, title, snippets[]}`
`answers`	AI answers — OpenAI-compatible, streaming by default	`.choices[0].delta.content` (stream)
`web`	Web search — all result types	`.web.results[]`, `.news.results[]`, etc.
`news`	News articles with freshness filters	`.results[]` -> `{title, url, age}`
`images`	Image search (up to 200 results)	`.results[]` -> `{title, url, thumbnail.src}`
`videos`	Video search with duration/views	`.results[]` -> `{title, url, video.duration}`
`places`	Local place/POI search (200M+ POIs)	`.results[]` -> `{title, postal_address}`
`suggest`	Autocomplete/query suggestions	`.results[]` -> `{query}`
`spellcheck`	Spell-check a query	`.results[0].query`
`config`	Manage API key and settings	`set-key`, `show-key`, `path`, `show`

Response Shapes

bx "query" (context — default, recommended)

{
  "grounding": {
    "generic": [
      { "url": "...", "title": "...", "snippets": ["extracted content...", "..."] }
    ]
  },
  "sources": {
    "https://example.com": { "title": "...", "hostname": "...", "age": ["...", "2025-01-15", "392 days ago"] }
  }
}

bx answers "query" --no-stream (single JSON response)

{"choices": [{"message": {"content": "Full answer text..."}}]}

bx answers "query" (streaming — default, one JSON chunk per line)

{"choices": [{"delta": {"content": "chunk"}}]}

bx web "query" (full search results)

{
  "web": { "results": [{"title": "...", "url": "...", "description": "..."}] },
  "news": { "results": [...] },
  "videos": { "results": [...] },
  "discussions": { "results": [...] }
}

Token Budget Control

Control output size for context (the default command):

Flag	Short alias	Default	Description
`--maximum-number-of-tokens`	`--max-tokens`	8192	Approximate total tokens (1024-32768)
`--maximum-number-of-tokens-per-url`	`--max-tokens-per-url`	4096	Max tokens per URL (512-8192)
`--maximum-number-of-urls`	`--max-urls`	20	Max URLs in response (1-50)
`--maximum-number-of-snippets`	`--max-snippets`	50	Max snippets across all URLs
`--maximum-number-of-snippets-per-url`	`--max-snippets-per-url`	—	Max snippets per URL
`--context-threshold-mode`	`--threshold`	balanced	Relevance: `strict`, `balanced`, `lenient`

bx "topic" --max-tokens 4096 --max-tokens-per-url 1024 --max-urls 5 --threshold strict

Goggles — Custom Ranking

Goggles let you control which sources appear in results. Boost official docs, suppress SEO spam, or build focused search scopes. No other search tool offers this. Supported on context, web, and news.

Domain Shortcuts

# Allowlist — only results from these domains
bx "rust axum" --include-site docs.rs --include-site github.com

# Blocklist — exclude specific domains
bx "python tutorial" --exclude-site example.com

--include-site, --exclude-site, and --goggles are mutually exclusive.

Inline Rules

# Boost official docs, demote blog posts
bx "axum middleware tower" \
  --goggles '$boost=5,site=docs.rs
$boost=3,site=github.com
/docs/$boost=5
/blog/$downrank=3' --max-tokens 4096

# Allowlist mode — only include matched sites
bx "Python asyncio patterns" \
  --goggles '$discard
$boost,site=docs.python.org
$boost,site=peps.python.org'

DSL Quick Reference

Rule	Effect	Example
`$boost=N,site=DOMAIN`	Promote domain (N=1-10)	`$boost=3,site=docs.rs`
`$downrank=N,site=DOMAIN`	Demote domain (N=1-10)	`$downrank=5,site=example.com`
`$discard,site=DOMAIN`	Remove domain entirely	`$discard,site=example.com`
`/path/$boost=N`	Boost matching URL paths	`/docs/$boost=5`
Generic `$discard`	Allowlist mode — discard unmatched	`$discard` (as first rule)

Separate rules with newlines. Full DSL: goggles-quickstart.

Piping Rules via Stdin

echo '$boost=5,site=docs.rs
$boost=5,site=crates.io
$boost=3,site=github.com' | bx "axum middleware" --goggles @- --max-tokens 4096

Use @/path/to/file to reuse a goggle across queries.

Agent Workflow Examples

Debugging an error:

bx "Python TypeError cannot unpack non-iterable NoneType" --max-tokens 4096

Corrective RAG loop:

# 1. Broad search
bx "axum middleware authentication" --max-tokens 4096
# 2. Too general? Narrow with strict threshold
bx "axum middleware tower layer authentication example" --threshold strict --max-tokens 4096
# 3. Still need synthesis? Ask for an answer
bx answers "how to implement JWT auth middleware in axum" --enable-research

Checking for breaking changes before upgrading:

bx "Next.js 15 breaking changes migration guide" --max-tokens 8192
bx news "Next.js 15 release" --freshness pm

Non-streaming answers for programmatic use:

bx answers "compare SQLx and Diesel for Rust" --no-stream

Answers via stdin (OpenAI-compatible JSON body):

echo '{"messages":[{"role":"user","content":"what are the OWASP top 10 vulnerabilities for web APIs"}]}' | bx answers -

Exit Codes

Code	Meaning	Agent action
0	Success	Process results
1	Client error (bad request)	Fix query/parameters
2	Usage error (bad flags)	Fix CLI arguments
3	Auth/permission error (401/403)	Check API key: `bx config show-key`
4	Rate limited (429)	Retry after delay
5	Server/network error	Retry with backoff

Use Cases

AI agents / coding assistants: One-call web search with token-budgeted, RAG-ready content — replaces search + scrape + extract
Fact-checking: Verify claims against current web content with bx "query" --threshold strict
Documentation lookup: Search official docs with --include-site or Goggles domain boosting
Research: Deep multi-source research with bx answers "topic" --enable-research
Debugging: Search for error messages and stack traces directly
News monitoring: Track topics with bx news "query" --freshness pd
Local search: Find businesses and places with bx places "query" --location "city"

Notes

All output is JSON to stdout; errors go to stderr
Global flags: --api-key KEY, --timeout SECS (default 30), --extra KEY=VALUE (repeatable, adds arbitrary API parameters)
Location awareness: context and web support --lat, --long, --city, --state, --state-name, --loc-country, --postal-code, --timezone
Research mode: bx answers --enable-research can take up to 5 minutes; set client timeout accordingly
Help: bx --help for all commands; bx <command> --help for per-command flags

FAQ

What does the bx skill do?

How do I install bx?

Run npx skills add https://github.com/brave/brave-search-skills --skill bx in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/bx/ (personal) or .claude/skills/bx/ (project).

Which AI agents can use bx?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is bx safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains bx?

It is published by brave in brave/brave-search-skills, and it is an official skill from the maker of the technology it covers. It has 1,122 recorded installs.

More from brave/brave-search-skills

View all →

web-search

brave/brave-search-skills

USE FOR web search. Returns ranked results with snippets, URLs, thumbnails. Supports freshness filters, SafeSearch, Goggles for custom ranking, pagination. Primary search endpoint.

OfficialProductivity & Automation4.7K installs

images-search

brave/brave-search-skills

USE FOR image search. Returns images with title, source URL, thumbnail. Supports SafeSearch filter. Up to 200 results.

OfficialMedia & Creative1.7K installs

news-search

brave/brave-search-skills

USE FOR news search. Returns news articles with title, URL, description, age, thumbnail, profile. Supports freshness and date range filtering, SafeSearch filter and Goggles for custom ranking.

Official1.6K installs

llm-context

brave/brave-search-skills

USE FOR RAG/LLM grounding. Returns pre-extracted web content (text, tables, code) optimized for LLMs. GET + POST. Adjust maxtokens/count based on complexity. Supports Goggles, local/POI. For AI answers use answers. Recommended for anyone building AI/agentic applications.

OfficialAI & Agents1.3K installs

videos-search

brave/brave-search-skills

USE FOR video search. Returns videos with title, URL, thumbnail, duration, view count, creator. Supports freshness filters, SafeSearch, pagination.

OfficialMedia & Creative1.2K installs

answers

brave/brave-search-skills

USE FOR AI-grounded answers via OpenAI-compatible /chat/completions. Two modes: single-search (fast) or deep research (enableresearch=true, thorough multi-search). Streaming/blocking. Citations.

OfficialProductivity & Automation1.2K installs

Popular ai & agents skills

View category →

google-agents-cli-publish

google/agents-cli

This skill should be used when the user wants to "publish an agent", "publish my ADK agent", "register an agent with Gemini", "publish to Gemini" (formerly Gemini Enterprise), or needs guidance on the agents-cli publish gemini command. Also use when the user wants to "manage agents in Agent Registry", "list/update/delete registered agents", or "register an MCP server". Covers ADK vs A2A registration modes, programmatic and interactive usage, flag reference, auto-detection from deployment metadata, Agent Registry fleet management, and troubleshooting. Part of the agents-cli skills suite. Do NOT use for deployment (use google-agents-cli-deploy).

AI & Agents513.9K installs

google-agents-cli-eval

google/agents-cli

This skill should be used when the user wants to "run an evaluation", "evaluate my agent", "evaluate my ADK agent", "write an eval dataset", "analyze eval failures", "compare eval results", "optimize agent", or needs guidance on the Gemini platform eval methodology and the Quality Flywheel. Covers eval metrics, dataset schema, LLM-as-judge scoring, and common failure causes. Applies to any agents-cli project, whatever framework the agent is written in. Do NOT use for agent API code patterns (ADK: use google-agents-cli-adk-code), deployment (use google-agents-cli-deploy), or project scaffolding (use google-agents-cli-scaffold).

AI & Agents513.5K installs

skill-creator

anthropics/skills

Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.

OfficialAI & Agents416.4K installs

codex-pet

prime-skills/runcomfy-agent-skills

Codex Pet generator on RunComfy. Build a Codex-compatible Codex Pet spritesheet.webp + pet.json from a single reference image, drop it into ${CODEXHOME:-$HOME/.codex}/pets/ / and Codex picks it up as a custom Codex Pet next to the 8 built-ins. This skill produces the exact Codex Pet atlas Codex expects (1536x1872 PNG/WebP, 8 cols x 9 rows, 192x208 cells, 9 animation states — idle, running-right, running-left, waving, jumping, failed, waiting, running, review). Calls OpenAI GPT Image 2 edit ONCE via the local RunComfy CLI as runcomfy run openai/gpt-image-2/edit to produce a canonical Codex Pet pose, then assembles all 9 animation rows programmatically with ImageMagick micro-transforms — no Codex Pro, no $imagegen, no OPENAIAPIKEY required, only RUNCOMFYTOKEN. Triggers on "codex pet", "create codex pet", "make codex pet", "hatch codex pet", "/hatch image", "desktop pet codex", "codex pets", "spritesheet.webp", or any explicit ask to build a custom pet for OpenAI Codex.

AI & Agents402.1K installs

full-output-enforcement

leonxlnx/taste-skill

Overrides default LLM truncation behavior. Enforces complete code generation, bans placeholder patterns, and handles token-limit splits cleanly. Apply to any task requiring exhaustive, unabridged output.

AI & Agents401K installs

executing-plans

obra/superpowers

Use when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available

AI & Agents245.7K installs

bx

Install

Install

Describe the task

Review the result

SKILL.md

bx — Brave Search CLI

Quick Start

When to Use Which Command

Commands

Response Shapes

Token Budget Control

Goggles — Custom Ranking

Domain Shortcuts

Inline Rules

DSL Quick Reference

Piping Rules via Stdin

Agent Workflow Examples

Exit Codes

Use Cases

Notes

FAQ

More from brave/brave-search-skills

Popular ai & agents skills