Quickstart

Get up and running with NeuAIs in under 5 minutes. This guide will help you deploy your first agent and verify it’s working.

Prerequisites

• Linux, macOS, or WSL2 on Windows
• curl or wget
• 2GB RAM minimum
• Internet connection

Step 1: Install the CLI

Install the NeuAIs CLI tool:

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

Verify the installation:

neuais --version

You should see:

neuais 0.1.0

Step 2: Authenticate

Create a free account and authenticate:

neuais auth login

This will open your browser to complete authentication. Once done, verify your login:

neuais auth whoami

Step 3: Deploy Your First Agent

Create a simple monitoring agent:

neuais agent deploy hello-world \
  --image neuais/examples:hello-world \
  --replicas 1

Check the deployment status:

neuais agent status hello-world

Expected output:

Agent: hello-world
Status: Running
Replicas: 1/1
Region: us-west-2
Uptime: 12s

Step 4: View Logs

Watch your agent’s logs in real-time:

neuais logs hello-world --tail 20 --follow

You should see output like:

[2024-01-15 10:23:45] hello-world-abc123: Agent started
[2024-01-15 10:23:46] hello-world-abc123: Health check: OK
[2024-01-15 10:23:47] hello-world-abc123: Processing tasks...

Press Ctrl+C to stop following logs.

Step 5: Scale Your Agent

Scale up to 5 replicas:

neuais agent scale hello-world --replicas 5

Verify the scaling:

neuais agent status hello-world

Output:

Agent: hello-world
Status: Running
Replicas: 5/5
Region: us-west-2
Uptime: 3m 42s

Step 6: Monitor in Observatory

Open the Observatory dashboard to see your agent in action:

neuais observatory open

This opens a 3D visualization of your agent network at http://localhost:3000.

Step 7: Clean Up

When you’re done, remove the agent:

neuais agent delete hello-world

Confirm the deletion:

neuais agent list

Next Steps

Troubleshooting

CLI not found

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

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

Add this line to your ~/.bashrc or ~/.zshrc to make it permanent.

Authentication failed

If authentication fails, try:

neuais auth logout
neuais auth login

Agent deployment stuck

Check the agent logs for errors:

neuais logs hello-world --tail 50

For more help, see Troubleshooting or file an issue.