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

# Install the CLI

> Install the sabaoth CLI on macOS, Linux or Windows

## Requirements

* **Node.js 22.12 or later, below 25.** Check your version with `node --version`.
* **npm**, which comes with Node.js.
* **An OS keychain** for storing your API key: Keychain on macOS, Credential Manager on Windows, or a Secret Service provider such as GNOME Keyring or KWallet on Linux. You don't need one if you only use the [`SABAOTH_API_KEY` environment variable](https://docs.sabaothcloud.com/cli/authentication#use-an-environment-variable), as in CI.

> [!TIP]
>
> If you need to install or switch Node.js versions, a version manager such as [nvm](https://github.com/nvm-sh/nvm), [fnm](https://github.com/Schniz/fnm) or [Volta](https://volta.sh) makes it easy.

## Install

The CLI is published to npm as `@sabaoth-cloud/cli`. It installs a command called `sabaoth`.

```bash theme={null}
npm install --global @sabaoth-cloud/cli
```

## Check the installation

```bash theme={null}
sabaoth --version
sabaoth --help
```

`sabaoth --help` lists the available commands. If your shell says `command not found`, see [Troubleshooting](https://docs.sabaothcloud.com/cli/troubleshooting.md#sabaoth-command-not-found).

## Update

Install the latest version over the top of the current one:

```bash theme={null}
npm install --global @sabaoth-cloud/cli@latest
```

Your saved login and organization selection are kept.

## Uninstall

Sign out first so your API keys are removed from the OS keychain, then remove the package:

```bash theme={null}
sabaoth logout --all
npm uninstall --global @sabaoth-cloud/cli
```

The CLI also keeps a small context file holding organization IDs and names, but no keys. To remove it too, delete the `sabaoth` folder at the location shown in the [table below](#where-the-cli-stores-data).

## Where the CLI stores data

The CLI stores two things on your machine.

**API keys** go into the OS keychain under the service name `com.sabaothcloud.sabaoth`, with one entry per organization (account `org:<organization-id>`). There is no plain-text fallback. If the keychain can't be reached, commands that need it fail rather than writing the key somewhere else.

**Context**, meaning the organizations you have signed in to and which one is selected, goes into a JSON file. It contains no secrets.

| OS | Context file |
| - | - |
| macOS | `~/Library/Application Support/sabaoth/context.json` |
| Linux | `$XDG_CONFIG_HOME/sabaoth/context.json`, or `~/.config/sabaoth/context.json` if `XDG_CONFIG_HOME` is not set |
| Windows | `%APPDATA%\sabaoth\context.json` |

Run [`sabaoth config`](https://docs.sabaothcloud.com/cli/commands/config) to see the exact path on your machine.

## API endpoint

The CLI always talks to `https://api.sabaothcloud.com`. There is no flag or environment variable to point it somewhere else. This is deliberate: an override would make it too easy to send an API key to the wrong server by mistake.

## Next step

> [card] [Sign in](https://docs.sabaothcloud.com/cli/authentication.md)
>
> Create an API key and log in.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.