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

# Installation

> Install the Ooneex CLI globally with Bun and enable Zsh completions.

The Ooneex CLI (`@ooneex/cli`) scaffolds applications, modules, controllers, services, and other resources from code generation templates. It exposes two binaries, `ooneex` and its short alias `oo`, which are interchangeable.

## Prerequisites

The CLI runs on [Bun](https://bun.sh). Install Bun before installing the CLI:

```bash theme={null}
curl -fsSL https://bun.sh/install | bash
```

Verify the installation:

```bash theme={null}
bun --version
```

## Global installation

Install the CLI globally with Bun:

```bash theme={null}
bun add -g @ooneex/cli
```

Confirm it is available:

```bash theme={null}
ooneex help
```

Both `ooneex` and `oo` resolve to the same binary, so every command in this section can be run with either name:

```bash theme={null}
ooneex app:create
oo app:create
```

To run the CLI without a global install, invoke it through `bunx`:

```bash theme={null}
bunx @ooneex/cli@latest app:create
```

## Zsh completions

The CLI ships context-aware Zsh completions for both the `oo` and `ooneex` binaries, including per-command option suggestions. Install them with:

```bash theme={null}
ooneex completion:zsh
```

This writes the completion files to `~/.zsh/_oo` and `~/.zsh/_ooneex`. If your shell does not already load completions from that directory, add the following to your `~/.zshrc`:

```bash theme={null}
fpath=(~/.zsh $fpath)
autoload -Uz compinit && compinit
```

Reload your shell or open a new terminal, then press <kbd>Tab</kbd> after a command to see available options:

```bash theme={null}
ooneex controller:create --<Tab>
```