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

# CLI

> Install and use the Shuriken command-line client for the v2 developer surface.

The Shuriken CLI is a thin Rust client over the same REST surface used by the SDKs. It's built for quick lookups, scripting, and testing without writing SDK code.

<Note>
  The CLI only supports HTTP endpoints. For real-time streams use the [WebSocket API](/api-reference/websocket/overview) directly or one of the [SDKs](/api-reference/introduction#sdks).
</Note>

## Install

```bash theme={null}
curl -fsSL https://cdn.shuriken.trade/shuriken-cli/install.sh | sh
```

The installer drops a single `shuriken` binary in `~/.local/bin`. Make sure that directory is on your `PATH`.

### Installer environment variables

| Variable                     | Purpose                                                  | Default                                   |
| ---------------------------- | -------------------------------------------------------- | ----------------------------------------- |
| `SHURIKEN_VERSION`           | Release channel or version to install                    | `latest`                                  |
| `SHURIKEN_INSTALL_DIR`       | Directory where the `shuriken` symlink is created        | `~/.local/bin`                            |
| `SHURIKEN_DOWNLOAD_BASE_URL` | Override the CDN base URL (mirrors or local smoke tests) | `https://cdn.shuriken.trade/shuriken-cli` |
| `NO_COLOR`                   | Disable colored installer output                         | unset                                     |

Pass them on the same line as `sh`:

```bash theme={null}
curl -fsSL https://cdn.shuriken.trade/shuriken-cli/install.sh | SHURIKEN_VERSION=v0.3.2 sh
curl -fsSL https://cdn.shuriken.trade/shuriken-cli/install.sh | SHURIKEN_INSTALL_DIR="$HOME/bin" sh
```

## Authentication

The CLI reads your API key from a config file or `SHURIKEN_API_KEY` environment variable. Create an [Agent Key](/agent-kit/create-agent-key) from the Terminal first, then:

```bash theme={null}
export SHURIKEN_API_KEY="your_api_key"
shuriken account me
```

## Updating

Installer-managed installs support channel-aware update detection and in-place updates:

```bash theme={null}
shuriken update check
shuriken update check --output json
shuriken update apply
```

<Tip>
  Pinned installs (`SHURIKEN_VERSION=vX.Y.Z`) stay pinned. Re-run the installer to move them to `latest` or another explicit version.
</Tip>

## Manual verification

To verify a release tarball manually, download the tarball plus checksum for your platform:

```bash theme={null}
curl -fsSLO https://cdn.shuriken.trade/shuriken-cli/releases/v0.3.2/shuriken-darwin-arm64.tar.gz
curl -fsSLO https://cdn.shuriken.trade/shuriken-cli/releases/v0.3.2/shuriken-darwin-arm64.tar.gz.sha256

shasum -a 256 -c shuriken-darwin-arm64.tar.gz.sha256
tar -xzf shuriken-darwin-arm64.tar.gz
./shuriken --version
```