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

# Install the CLI

> Install or update the hosted Almanac command-line interface.

Almanac requires Python 3.12 or later. The installer uses `uv` to install the
`the-almanac` package and exposes the `almanac` command.

## Install

```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
curl -fsSL https://usealmanac.com/install.sh | sh
almanac --version
```

If the command is not found, open a new shell so its tool directory is on your
`PATH`.

## Install with uv directly

```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
uv tool install the-almanac
```

## Update

```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
almanac update
```

`almanac update` prints the current manual upgrade command. You can also run:

```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
uv tool install --upgrade the-almanac
```

## Verify the environment

```bash theme={"theme":{"light":"github-light","dark":"vesper"}}
almanac doctor
```

Doctor checks local endpoint configuration, whether credentials exist, the
nearest `.almanac.yaml` directory link, and installed agent guidance. It does not
evaluate `ALMANAC_WIKI` or an explicit command flag. Run `almanac whoami` to
verify the credential against the hosted service. Continue with [Sign in](/getting-started/authenticate),
or run the complete [first-wiki tutorial](/quickstart).
