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

# Installation Guide

> Install and configure the Neo CLI

## Prerequisites

Before installing the Neo CLI, ensure you have:

* **Flutter** installed and configured ([Flutter installation guide](https://flutter.dev/docs/get-started/install))
* **Access to the Neo repository** granted by TVK through the GitHub organization

<Info>
  If you don't have access yet, ask your team lead or administrator to contact TVK with your GitHub account email address. Your organization needs an active Neo subscription with confirmed payment before developers can receive repository access.
</Info>

## SSH Setup for GitHub

Since Neo is a private repository, you'll need SSH access configured. If you don't already have SSH keys set up:

1. **Check for existing SSH keys**: `ls -al ~/.ssh`
2. **Generate a new SSH key** (if needed): [GitHub's SSH guide](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
3. **Add the SSH key to your GitHub account**

<Tip>
  If you use a passphrase for your SSH key, consider using a password manager to store it securely.
</Tip>

## Installing the Neo CLI

Choose your platform for installation instructions:

<Tabs>
  <Tab title="macOS">
    Install using [Homebrew](https://brew.sh):

    ```bash theme={null}
    brew install tvkcompany/neo/neo
    ```

    **Verify installation:**

    ```bash theme={null}
    neo --version
    ```
  </Tab>

  <Tab title="Windows">
    Install using [Scoop](https://scoop.sh):

    ```powershell theme={null}
    scoop bucket add neo https://github.com/tvkcompany/scoop-neo.git
    scoop install neo
    ```

    **Verify installation:**

    ```powershell theme={null}
    neo --version
    ```
  </Tab>

  <Tab title="Linux">
    Install using [Homebrew](https://brew.sh):

    ```bash theme={null}
    brew install tvkcompany/neo/neo
    ```

    **Verify installation:**

    ```bash theme={null}
    neo --version
    ```
  </Tab>
</Tabs>

## Configure the Neo CLI

After installation, configure the Neo CLI with your default settings:

```bash theme={null}
neo config
```

This interactive setup will guide you through setting up the Neo CLI.

<Info>
  For detailed information about configuration options and all Neo CLI commands, see the [Commands & Options](/cli/commands) page.
</Info>

## Getting Help

Access help documentation anytime:

<CodeGroup>
  ```bash General help theme={null}
  neo help
  ```

  ```bash Command-specific help theme={null}
  neo help create
  neo help config
  ```

  ```bash Alternative formats theme={null}
  neo --help
  neo -h
  ```
</CodeGroup>

## Updating the Neo CLI

When a new version is released, you can update the Neo CLI:

<Tabs>
  <Tab title="macOS">
    ```bash theme={null}
    brew upgrade neo
    ```

    <Tip>
      You can check if there is a new version available by running `brew outdated neo`.
    </Tip>
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    scoop update neo
    ```

    <Tip>
      You can check if there are any updates available by running `scoop status`.
    </Tip>
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    brew upgrade neo
    ```

    <Tip>
      You can check if there is a new version available by running `brew outdated neo`.
    </Tip>
  </Tab>
</Tabs>

## Uninstalling the Neo CLI

If you need to uninstall the Neo CLI:

<Tabs>
  <Tab title="macOS">
    ```bash theme={null}
    brew uninstall neo
    brew untap tvkcompany/neo
    ```
  </Tab>

  <Tab title="Windows">
    ```powershell theme={null}
    scoop uninstall neo
    scoop bucket rm neo
    ```
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    brew uninstall neo
    brew untap tvkcompany/neo
    ```
  </Tab>
</Tabs>

## Next Step

Once you have installed and configured the Neo CLI, you can proceed to [creating your first Neo project](/creating-project).