> ## Documentation Index
> Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# Install the CLI

> Install the unkey CLI from npm or a GitHub release and check its version.

export const versions = {
  cli: "2.0.150",
  tsApi: "2.5.1",
  tsRatelimit: "2.1.4",
  tsHono: "2.0.0",
  tsNextjs: "2.0.0",
  tsCache: "1.5.0",
  tsNuxt: "1.1.15",
  goSdk: "v3.0.1",
  pySdk: "3.0.3"
};

The CLI is a single static binary named `unkey`.

```bash theme={"system"}
npm install -g unkey
```

Without Node, download the archive for your platform from the [releases page](https://github.com/unkeyed/unkey/releases) and put the `unkey` binary on your `PATH` instead. Both paths ship the same binary, currently {versions.cli}.

## Supported platforms

The CLI runs on Linux and macOS, on both x86\_64 and arm64. There's no Windows build. On the [releases page](https://github.com/unkeyed/unkey/releases), CLI releases are tagged `cli/vX.Y.Z` and each archive is named `unkey_<OS>_<arch>.tar.gz`, for example `unkey_Darwin_arm64.tar.gz` for an Apple silicon Mac or `unkey_Linux_x86_64.tar.gz`. On npm, stable releases are tagged `latest` and pre-releases `next`.

## Check the installation

```bash theme={"system"}
unkey --version
```

This prints the installed version. `unkey --help` lists top-level commands. See [The unkey CLI](/docs/platform/cli/overview) for how they're organized.

## Next steps

<Columns cols={2}>
  <Card title="CLI authentication" icon="key" href="/docs/platform/cli/authentication">
    Store a root key with `unkey auth login` or pass one per command.
  </Card>

  <Card title="Output and shared flags" icon="terminal" href="/docs/platform/cli/output-and-flags">
    JSON output for scripts and the flags every `unkey api` command accepts.
  </Card>
</Columns>