Skip to main content

Prerequisites

Before installing the Neo CLI, ensure you have:
  • Flutter installed and configured (Flutter installation guide)
  • Access to the Neo repository granted by TVK through the GitHub organization
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.

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
  3. Add the SSH key to your GitHub account
If you use a passphrase for your SSH key, consider using a password manager to store it securely.

Installing the Neo CLI

Choose your platform for installation instructions:
  • macOS
  • Windows
  • Linux
Install using Homebrew:
brew install tvkcompany/neo/neo
Verify installation:
neo --version

Configure the Neo CLI

After installation, configure the Neo CLI with your default settings:
neo config
This interactive setup will guide you through setting up your organization identifier, default platforms, and preferred template.
For detailed information about configuration options and all Neo CLI commands, see the Commands & Options page.

Getting Help

Access help documentation anytime:
neo help

Updating the Neo CLI

When a new version is released, you can update the Neo CLI:
  • macOS
  • Windows
  • Linux
brew upgrade neo
You can check if there is a new version available by running brew outdated neo.

Uninstalling the Neo CLI

If you need to uninstall the Neo CLI:
  • macOS
  • Windows
  • Linux
brew uninstall neo
brew untap tvkcompany/neo

Next Step

Once you have installed and configured the Neo CLI, you can proceed to creating your first Neo project.
I