Install the CLI
The scope CLI lets you submit requests, list runs, stream logs,
and manage profiles — all from your terminal.
Prerequisites
Section titled “Prerequisites”- Node.js ≥ 20 — nodejs.org
- GitHub CLI (
gh) — authenticated with access to thegrowth-ecosystems/scope-docrepo.
Alternatively, set aGH_TOKENorGITHUB_TOKENenvironment variable withreposcope.
One-liner install
Section titled “One-liner install”gh api repos/growth-ecosystems/scope-doc/contents/install-cli.sh \ -H "Accept: application/vnd.github.raw" | bashThis downloads and installs the latest release to
~/.local/bin/scope. Override the location with the
SCOPE_INSTALL_DIR environment variable:
SCOPE_INSTALL_DIR=~/bin \ gh api repos/growth-ecosystems/scope-doc/contents/install-cli.sh \ -H "Accept: application/vnd.github.raw" | bashAdd to PATH
Section titled “Add to PATH”If ~/.local/bin is not already on your PATH, add it to your
shell profile:
# ~/.bashrc, ~/.zshrc, or ~/.profileexport PATH="$HOME/.local/bin:$PATH"Then reload your shell or run source ~/.bashrc (or equivalent).
Verify the installation
Section titled “Verify the installation”scope --versionYou should see the installed version number printed to stdout.
Updating
Section titled “Updating”scope updateThis downloads and installs the latest cli/v* release,
replacing the current binary in place.
What’s next
Section titled “What’s next”- Submitting requests (CLI) — the full CLI workflow guide.
- Submitting requests (REST API) — the endpoints the CLI wraps.