Skip to main content
The useagents CLI searches the live UseAgents registry, fetches implementation context, and searches a tool’s official documentation from a terminal or script.

​
Install with npm

The package exposes the useagents command and works with npm, pnpm, yarn, or Bun global installs.

​
Install a standalone binary

On macOS or Linux, the installer detects your operating system and CPU architecture, verifies the SHA-256 checksum, and installs to ${XDG_BIN_HOME:-$HOME/.local/bin}:
If the command is not found, add the install directory to your PATH:
The binaries are published as GitHub Release assets. They are not stored in the web application repository. Set USEAGENTS_VERSION=v1.2.3 to install a specific release. Windows users can install the npm package or download the Windows asset manually from the release page.

​
Upgrade

Standalone binary installs can self-upgrade by re-running the official install script:
upgrade runs curl -fsSL https://useagents.site/cli/install.sh | sh. Pass --release or set USEAGENTS_VERSION to pin a tag. Check the installed version with useagents --version. If you installed via npm, upgrade with:
Binary upgrades are not supported on Windows; use the npm package there.

​
Search the registry

Useful aliases include -l for --language, -t for --transport, and -c for --category.

​
Fetch context

Context includes the full description, source links, matching quickstarts, install steps, examples, and input/output guidance.

​
Search documentation

Docs search resolves the tool’s official docs URL from the registry and returns ranked passages for your question.

​
Test a snippet in the sandbox

--file is relative to the current directory and may be repeated. --package and --env NAME=value are also repeatable. The CLI POSTs to /tools/test and exits 1 when ok is false. The sandbox allows outbound network so live vendor API calls can run; pass keys with --env. JavaScript and TypeScript (--runtime node) use the Bun runtime to add packages and run files. Reuse a previous sandbox with the sessionId from the last result. The box is paused between runs and has no hard TTL.

​
Output formats

--format wins over --json and over the pipe default. Structured success uses one envelope per command (command, query, data, meta). Progress output, if enabled, is sent to stderr.
See Response formats for how API and MCP defaults differ. Run useagents --help, useagents search --help, useagents context --help, useagents docs --help, useagents test --help, or useagents upgrade --help for all flags.