# Install the CLI

[Read this page in HTML](https://www.scopedb.io/docs/guides/scopedb-cli)

The ScopeDB CLI runs queries and manages a workspace from a terminal or script. Its executable is `scope`. These guides cover **0.2.0**, currently in public preview.

> **Note: Upgrading to 0.2.0?**
>
> Review the [0.2.0 upgrade steps](https://www.scopedb.io/docs/release-notes/2026-10-25-cli-0-2-0.md#upgrade) to update API key revocation scripts and JSON consumers. The same note links the additional command and login changes for release-candidate users.

## Install

### Download a release

Download v0.2.0 for your platform:

| Platform             | Download                                                                                                          |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- |
| macOS, Apple silicon | [ARM64 archive](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_darwin_arm64.tar.gz)  |
| macOS, Intel         | [x86-64 archive](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_darwin_amd64.tar.gz) |
| Linux, x86-64        | [x86-64 archive](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_linux_amd64.tar.gz)  |
| Linux, ARM64         | [ARM64 archive](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_linux_arm64.tar.gz)   |
| Windows, x86-64      | [x86-64 ZIP](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_windows_amd64.zip)       |
| Windows, ARM64       | [ARM64 ZIP](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/scope_0.2.0_windows_arm64.zip)        |

Download the release's [SHA-256 checksums](https://github.com/scopedb/scopedb-cli/releases/download/v0.2.0/checksums.txt) and compare the digest for your archive before extracting it. On macOS, use `shasum -a 256 <archive>`; on Linux, use `sha256sum <archive>`; on Windows, use `Get-FileHash <archive> -Algorithm SHA256` in PowerShell.

On macOS or Linux, extract the archive and put `scope` on your `PATH`. For example, from a directory containing only the downloaded ScopeDB CLI archive:

```bash
tar -xzf scope_*.tar.gz scope
mkdir -p "$HOME/.local/bin"
install -m 0755 scope "$HOME/.local/bin/scope"
export PATH="$HOME/.local/bin:$PATH"
scope version
```

Add the `export PATH=...` line to your shell profile to keep `scope` available in new terminals. On Windows, extract the ZIP, add the directory containing `scope.exe` to your `PATH`, then run `scope version`.

Official Homebrew, Scoop, and winget packages are not available yet. Use the release archives or Go source instead of an unverified package with a similar name.

### Build from source

With Go 1.27 or later:

```bash
go install github.com/scopedb/scopedb-cli/cmd/scope@v0.2.0
```

The binary is installed in `GOBIN`, or `$(go env GOPATH)/bin` when `GOBIN` is unset. Ensure that directory is on your `PATH` before running `scope version`. To install or update to the newest release version, replace `@v0.2.0` with `@latest`; this does not follow repository main.

## Connect and next steps

[Sign in and select a workspace](https://www.scopedb.io/docs/guides/scopedb-cli/connect.md) to use the CLI interactively, then [run queries](https://www.scopedb.io/docs/guides/scopedb-cli/query.md), [manage Catalog definitions](https://www.scopedb.io/docs/guides/scopedb-cli/catalog.md), or [create and revoke API keys](https://www.scopedb.io/docs/guides/scopedb-cli/api-keys.md). For CI or unattended jobs, [configure an endpoint and API key](https://www.scopedb.io/docs/guides/scopedb-cli/automation.md); no CLI login is required.

## Related contents

* [Connect the CLI](https://www.scopedb.io/docs/guides/scopedb-cli/connect.md)

* [Query data with the CLI](https://www.scopedb.io/docs/guides/scopedb-cli/query.md)

* [CLI 0.2.0 release notes](https://www.scopedb.io/docs/release-notes/2026-10-25-cli-0-2-0.md)

* [ScopeDB CLI repository](https://github.com/scopedb/scopedb-cli)