Installation

Install the NeuAIs CLI and SDKs on your system. The CLI provides complete control over your agent infrastructure from the command line.

System Requirements

• Operating System: Linux, macOS, or Windows (WSL2)
• Memory: 2GB RAM minimum, 4GB recommended
• Disk: 500MB free space
• Network: Internet connection for initial setup

Install CLI

Quick Install (Recommended)

Use our installation script:

curl -sSL https://install.neuais.com | sh

This script will:

1. Detect your operating system and architecture
2. Download the latest stable release
3. Install to ~/.neuais/bin/
4. Add to your PATH automatically

Manual Installation

Linux (x86_64)

wget https://github.com/neuais/cli/releases/latest/download/neuais-linux-amd64.tar.gz
tar -xzf neuais-linux-amd64.tar.gz
sudo mv neuais /usr/local/bin/

macOS (Intel)

wget https://github.com/neuais/cli/releases/latest/download/neuais-darwin-amd64.tar.gz
tar -xzf neuais-darwin-amd64.tar.gz
sudo mv neuais /usr/local/bin/

macOS (Apple Silicon)

wget https://github.com/neuais/cli/releases/latest/download/neuais-darwin-arm64.tar.gz
tar -xzf neuais-darwin-arm64.tar.gz
sudo mv neuais /usr/local/bin/

Windows (WSL2)

wget https://github.com/neuais/cli/releases/latest/download/neuais-windows-amd64.zip
unzip neuais-windows-amd64.zip
mv neuais.exe C:\Windows\System32\

Verify Installation

neuais --version

Expected output:

neuais 0.1.0
Build: 2024-01-15T10:00:00Z
Commit: abc123def

Install Language SDKs

Rust SDK

Add to your Cargo.toml:

[dependencies]
neuais-sdk = "0.1"
tokio = { version = "1", features = ["full"] }

Example usage:

use neuais_sdk::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    let client = NeuaisClient::new()?;
    
    let agents = client.agents().list().await?;
    println!("Found {} agents", agents.len());
    
    Ok(())
}

Go SDK

go get github.com/neuais/sdk-go

Example usage:

package main

import (
    "fmt"
    "github.com/neuais/sdk-go/neuais"
)

func main() {
    client := neuais.NewClient()
    
    agents, err := client.Agents().List()
    if err != nil {
        panic(err)
    }
    
    fmt.Printf("Found %d agents\n", len(agents))
}

Python SDK

pip install neuais

Example usage:

from neuais import Client

client = Client()

agents = client.agents.list()
print(f"Found {len(agents)} agents")

TypeScript/JavaScript SDK

npm install @neuais/sdk
# or
yarn add @neuais/sdk

Example usage:

import { NeuaisClient } from '@neuais/sdk';

const client = new NeuaisClient();

const agents = await client.agents.list();
console.log(`Found ${agents.length} agents`);

Configuration

Set Up Authentication

Create a free account:

neuais auth signup

Or log in if you have an account:

neuais auth login

This opens your browser for authentication. Once complete, your credentials are stored in ~/.neuais/credentials.

Configuration File

Create ~/.neuais/config.toml:

[default]
region = "us-west-2"
output = "json"

[profile.production]
region = "us-east-1"
output = "table"
endpoint = "https://api.neuais.com"

[profile.development]
region = "local"
output = "json"
endpoint = "http://localhost:8080"

Use profiles:

# Use default profile
neuais agent list

# Use production profile
neuais agent list --profile production

# Use development profile
neuais agent list --profile development

Environment Variables

Configure via environment variables:

# API endpoint
export NEUAIS_ENDPOINT="https://api.neuais.com"

# Authentication token
export NEUAIS_TOKEN="your-token-here"

# Default region
export NEUAIS_REGION="us-west-2"

# Log level (debug, info, warn, error)
export NEUAIS_LOG_LEVEL="info"

# Output format (json, table, yaml)
export NEUAIS_OUTPUT="json"

Shell Completion

Bash

neuais completion bash > /etc/bash_completion.d/neuais

Zsh

neuais completion zsh > ~/.zsh/completion/_neuais

Fish

neuais completion fish > ~/.config/fish/completions/neuais.fish

Docker Image

Run the CLI in Docker:

docker pull neuais/cli:latest

docker run --rm -it \
  -v ~/.neuais:/root/.neuais \
  neuais/cli:latest agent list

Create an alias for convenience:

alias neuais='docker run --rm -it -v ~/.neuais:/root/.neuais neuais/cli:latest'

Upgrading

Upgrade CLI

neuais upgrade

Or reinstall:

curl -sSL https://install.neuais.com | sh

Upgrade SDKs

Rust

cargo update neuais-sdk

Go

go get -u github.com/neuais/sdk-go

Python

pip install --upgrade neuais

TypeScript/JavaScript

npm update @neuais/sdk
# or
yarn upgrade @neuais/sdk

Troubleshooting

Command not found

If neuais is not found after installation, add to your PATH:

export PATH="$HOME/.neuais/bin:$PATH"

Add this line to your shell config:

# For bash
echo 'export PATH="$HOME/.neuais/bin:$PATH"' >> ~/.bashrc

# For zsh
echo 'export PATH="$HOME/.neuais/bin:$PATH"' >> ~/.zshrc

Permission denied

If you get permission errors:

chmod +x ~/.neuais/bin/neuais

SSL/TLS errors

If you encounter SSL certificate errors:

# Update CA certificates (Linux)
sudo apt-get update && sudo apt-get install ca-certificates

# Update CA certificates (macOS)
brew install ca-certificates

Connection refused

Check your network connection and firewall settings. Verify the endpoint:

curl -v https://api.neuais.com/health

Next Steps