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

# Installation

> Install the `oi` CLI from GitHub releases, Homebrew, or source.

## Install from GitHub releases

The install script downloads the correct binary for your platform and places it on your PATH.

<Note>
  `GITHUB_TOKEN` is required when releases are hosted in a private repository. Use a token with `repo` read scope.
</Note>

```bash theme={null}
export GITHUB_TOKEN=<github-token-with-repo-read>
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
  https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash
```

### Install a specific version

Pin to a specific release tag:

```bash theme={null}
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
  https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash -s -- --tag v0.10.0
```

### Install from stable releases only

Skip pre-release and release-candidate builds:

```bash theme={null}
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
  https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash -s -- --stable
```

## Update an existing installation

Update the `oi` binary in place without re-running the install script:

<CodeGroup>
  ```bash Latest theme={null}
  oi update
  ```

  ```bash Stable channel only theme={null}
  oi update --stable
  ```

  ```bash Pin to a tag theme={null}
  oi update --tag v0.10.0
  ```
</CodeGroup>

## Install with Homebrew

<Note>
  The Homebrew tap becomes available after a public tap release. If the tap is not yet published, use the GitHub release install method above.
</Note>

```bash theme={null}
brew tap openindex/tap
brew install oi
```

## Build from source

You need [Bun](https://bun.sh) and Go installed. Clone the repository and run:

```bash theme={null}
bun run build:cli
./bin/oi version
```

## First-run setup

After installing, run the following commands to verify your environment and configure `oi`:

<Steps>
  <Step title="Check install prerequisites">
    Verify that all runtime dependencies are in place:

    ```bash theme={null}
    oi install-check
    ```
  </Step>

  <Step title="Run guided setup">
    Initialize your first profile interactively:

    ```bash theme={null}
    oi init
    ```
  </Step>

  <Step title="Diagnose your environment">
    Run a full health check across config, connectivity, and auth:

    ```bash theme={null}
    oi doctor
    ```
  </Step>
</Steps>