Documentation
Run web search, markdown extraction, and site mapping from the terminal.
These guides explain webctx from user and maintainer perspectives: install paths, credential loading, command behavior, provider-specific requests, ranking and deduping, Firecrawl fallbacks, npm distribution, release checks, and common failure modes.
Start
Quickstart
Install webctx, configure provider keys, and run the first search, read-link, and map-site commands.
Open guideInstall and distribution
Understand the npm install path, GitHub release assets, source builds, local installs, and supported platforms.
Open guideAgent workflows
Use webctx as a terminal context tool for coding agents, research agents, and documentation agents.
Open guideCommands
Search command
Use Brave, Tavily, and Exa together, filter noisy domains, run Exa keyword mode, and understand result formatting.
Open guideRead-link command
Convert a URL into clean markdown using GitHub raw-content fast paths, direct markdown detection, and Firecrawl fallback scraping.
Open guideMap-site command
Use Firecrawl's map endpoint to return a sitemap-style list of URLs for a website.
Open guideCredentials
Internals
Search ranking
Understand URL normalization, provider weighting, duplicate bonuses, excluded-domain filtering, and result caps.
Open guideArchitecture
Learn how the Go CLI, app package, provider clients, scrape helpers, npm shim, postinstall script, and release pipeline fit together.
Open guideDevelopment and release
Run quality checks, build local and cross-platform binaries, install locally, tag releases, and publish npm packages.
Open guideReference
CLI reference
A compact reference for webctx commands, flags, environment variables, output formats, and maintainer targets.
Open guideTroubleshooting
Diagnose missing keys, empty search results, provider failures, Firecrawl errors, npm install failures, markdown fallback behavior, and release issues.
Open guideDocs site maintenance
Run, edit, validate, and deploy the Astro documentation site embedded in the webctx repository.
Open guide