Skip to main content

​
macOS and Linux

Installs the current release directly: a signed static binary, nothing else to set up. It goes to /usr/local/bin when you can write there, and to ~/.local/bin otherwise; a stock Mac does not have ~/.local/bin on its PATH, so the second line makes outcrawl findable in this shell. The installer prints the same line when it is needed; add it to your shell profile to keep it. Or with Homebrew, which puts it on your PATH for you:

​
Windows

Scoop
Or download the platform archive directly:
1

Read the manifest

GET https://get.outcrawl.ai/cli/manifest.json lists the current version and a sha256 digest for every platform, including windows_amd64 and windows_arm64.
2

Download the archive

The path pattern is https://get.outcrawl.ai/cli/<version>/outcrawl_<version>_windows_<arch>.zip, built from the version the manifest just gave you.
3

Verify before you run it

Hash the download against the manifest’s digest before extracting. This is the same three-hash discipline outcrawl upgrade runs on every update: publish against download, the archive’s own contents, and the installed binary, each checked separately.

​
Sign in

Opens a browser with a short code already filled in; approve it, pick a workspace, and the CLI is signed in. This is the RFC 8628 device grant, the same standard flow GitHub’s and AWS’s own CLIs use: no password or key touches your terminal. The session stays signed in until you run outcrawl logout, or you are removed from the workspace, either of which cuts it off at once.

​
CI and headless environments

Nothing to click through on a server. Use an API key instead, either the environment variable or the config file, and it takes priority over a stored login:
The config file lives at $XDG_CONFIG_HOME/outcrawl/config.json (%APPDATA%\outcrawl\config.json on Windows). Precedence is flag, then environment variable, then a stored login or the file, then default. OUTCRAWL_API_URL overrides the default base URL if you need to.
--verbose never prints the key itself, and scrubs it from its own error messages too, so a mistyped flag never leaks a credential into your terminal history.

​
Staying current

A background check runs at most once every 24 hours and never blocks a command; set OUTCRAWL_NO_VERSION_CHECK=1 to turn it off entirely.