Quick Start

Get up and running with Neural Commander in 5 minutes.

🚧

Coming Soon — Beta Waitlist Goal: 100 signups

Downloads will be available when our beta waitlist reaches 100 developers. Join the waitlist to get early access.

1 Installation

# Download the latest release
curl -LO https://github.com/neural-commander/nc/releases/latest/download/nc-linux-amd64
chmod +x nc-linux-amd64
mv nc-linux-amd64 ~/.local/bin/nc

# Verify installation
nc --version

# Download the latest release
curl -LO https://github.com/neural-commander/nc/releases/latest/download/nc-windows-amd64.exe

# Move to your PATH
move nc-windows-amd64.exe C:\Users\YourName\bin\nc.exe

# Verify installation
nc --version

2 First Run

# Initialize NC for your project
nc init

# Start the daemon for session monitoring
nc daemon start

# Check project health
nc audit .

The nc init command creates a .nc-config.yaml file in your project root with default settings.

3 Basic Commands

Command	Description
`nc init`	Initialize NC for current project
`nc daemon start`	Start background monitoring
`nc audit [path]`	Run project health audit
`nc session list`	List all sessions
`nc docs health`	Check documentation health

4 New Project Setup

# 1. Initialize NC
nc init

# 2. Generate AI guardrails
nc guardrails init --claude-md

# 3. Set up test scaffolding
nc test init

# 4. Check IDE compatibility
nc test ide-compat

# 5. Start daemon
nc daemon start

5 (Optional) Enable AI Features

Core features work without AI. This step is optional if you want AI-enhanced capabilities like nc chat and smart suggestions.

Option A: Local AI (Free)

# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a model
ollama pull llama3.2

# NC auto-detects Ollama!
nc chat "Hello!"

Option B: Cloud AI (BYOK)

# Set your API key
nc config set ai.provider openai
nc config set ai.api_key sk-...

# Ready to use
nc chat "Hello!"

Full AI setup guide →

6 Configuration

Neural Commander stores configuration in .nc-config.yaml:

version: "1.0"
project:
  name: my-project
  type: api

daemon:
  check_interval: 30s
  api_port: 7669

alerts:
  desktop_notifications: true
  slack_webhook: ""

tier: community

Environment Variables

Variable	Description
`NC_HOME`	NC data directory (default: `~/.neural-commander`)
`NC_API_PORT`	API server port (default: 7669)
`NC_LOG_LEVEL`	Log level (debug, info, warn, error)