Source: https://sparetokens.ai/install
Description: How to install the SpareTokens worker with pipx, Homebrew or a one-line installer on macOS, Linux and Windows through WSL2. Available at launch.

# Install SpareTokens

One command for macOS, Linux and Windows through WSL2. The package is built and checked, and ships at launch.

[Read the quickstart](https://sparetokens.ai/docs/quickstart)[Get started](https://sparetokens.ai/join)

[Available at launch] The worker package is built, checked and ready, but not published yet. The commands below are exactly what you will run on launch day, so they will not work until then. [Get started](https://sparetokens.ai/join) to be told when they do. Invited to the private beta? Your dashboard gives you a private install command that uses this installer with a link only your account can use.

## Install SpareTokens

One command per system. Pick yours; every option installs the same `sparetokens` command and nothing starts running until you run `sparetokens setup`. You need Python 3.10 or newer (the installer checks), and macOS, Linux or Windows. See [system requirements](https://sparetokens.ai/docs/requirements).
- [macOS](#macos)
- [Linux](#linux)
- [Windows](#windows)

## macOS

The macOS sandbox (`sandbox-exec`) is built in, so there is nothing else to install.

### Homebrew [Available at launch]

```
brew install pfergi42/sparetokens/sparetokens
```

### pipx [Available at launch]

```
brew install pipx
pipx install sparetokens
```

### One-line installer [Available at launch]

```
curl -fsSL https://sparetokens.ai/install.sh | sh
```

## Linux

Install bubblewrap for the sandbox that shell and solver tasks use: `sudo apt install bubblewrap` on Debian and Ubuntu, or `sudo dnf install bubblewrap` on Fedora. Without it the worker still runs, but offers no shell tasks.

### pipx [Available at launch]

```
pipx install sparetokens
```

### Homebrew on Linux [Available at launch]

```
brew install pfergi42/sparetokens/sparetokens
```

### One-line installer [Available at launch]

```
curl -fsSL https://sparetokens.ai/install.sh | sh
```

## Windows

The best path is WSL2 (Windows Subsystem for Linux), which is a real Linux, so the full sandbox works. Open PowerShell and run:

```
wsl --install -d Ubuntu
```

Restart if asked, open Ubuntu from the Start menu, then follow the Linux steps above inside it. The one-line installer runs there.

Native Windows also works for tasks that need no shell, such as literature checks. In PowerShell:

```
pipx install sparetokens
```

[Available at launch] Shell and solver tasks are refused on native Windows with a pointer back to WSL2, because there is no sandbox we trust there. See [what works on each system](https://sparetokens.ai/docs/requirements#per-os).

## Check that it worked

```
sparetokens --version
sparetokens doctor
```

`sparetokens doctor` is a read-only self-check. It reports your operating system, whether a sandbox is available, which providers it found, what the provider terms allow, where your config lives and whether the coordinator answers. On macOS it also suggests keeping a provider key in the Keychain (`keychain:`) when a source reads it from an environment variable (`env:`). It never prints a key and changes nothing. Add `--offline` to skip the network check or `--json` for a machine-readable report.

Then continue with the [quickstart](https://sparetokens.ai/docs/quickstart).

## How the installer proves what it downloads

Each release publishes a `SHA256SUMS` file next to the wheel, the pinned `constraints.txt` and the installer. The one-line installer downloads them, checks the SHA-256 of what it fetched, and stops without installing anything if a checksum does not match. It prints what it will do first and asks you to confirm (use `--yes` to skip the question). It never runs as root and never uses `sudo`.

If you want to read before you run, download the script and open it: `curl -fsSLO https://sparetokens.ai/install.sh`, then `sh install.sh --dry-run` prints the plan and changes nothing. You can also give it the checksum you expect with `--sha256`. Release files are signed with Sigstore, so you can verify them yourself with `cosign verify-blob`.

## What to do next

Follow the guide that matches what you have. Each one is a single page that ends at your first verified result: [API credit](https://sparetokens.ai/start/api-credit), [a local model with Ollama](https://sparetokens.ai/start/local-model), [your own AI agent](https://sparetokens.ai/start/agent) or [a company or lab](https://sparetokens.ai/start/teams). The [chooser](https://sparetokens.ai/start) helps you pick.

## Remove it

Run `sparetokens uninstall` first to remove the background service and local config, then `pipx uninstall sparetokens` or `brew uninstall sparetokens`.

## Keep reading
- [Quickstart: set up and run your first task](https://sparetokens.ai/docs/quickstart)
- [System requirements for the worker](https://sparetokens.ai/docs/requirements)
- [How your key stays on your machine](https://sparetokens.ai/security)

---
Part of SpareTokens (https://sparetokens.ai/). Full site index for agents: https://sparetokens.ai/llms.txt
