Skip to main content

Quick Start

Get Neural Commander running in under 5 minutes.

Beta Release

Neural Commander v0.99.0 is currently in public beta. Download from the releases page or visit neuralcommander.ai.

Prerequisites​

  • Ollama (recommended for local AI models) - Install Ollama
  • Git (optional, for build from source)

Installation​

Step 1: Download Binary​

Go to the releases page and download for your platform:

PlatformFile
Linux (Intel/AMD)neural-commander-linux-amd64
Linux (ARM)neural-commander-linux-arm64
macOS (Intel)neural-commander-darwin-amd64
macOS (M1/M2/M3)neural-commander-darwin-arm64
Windowsneural-commander-windows-amd64.exe

Step 2: Install​

Linux / macOS:

# Make executable
chmod +x neural-commander-*

# Move to PATH
mv neural-commander-linux-amd64 ~/.local/bin/nc
# OR for macOS:
# mv neural-commander-darwin-arm64 ~/.local/bin/nc

# Ensure ~/.local/bin is in PATH
echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
source ~/.bashrc

Windows (PowerShell):

# Create directory if needed
mkdir $env:USERPROFILE\.local\bin -ErrorAction SilentlyContinue

# Move binary
Move-Item neural-commander-windows-amd64.exe $env:USERPROFILE\.local\bin\nc.exe

# Add to PATH
$env:PATH += ";$env:USERPROFILE\.local\bin"

Step 3: Verify Installation​

ncmd version
# Neural Commander v0.99.0-beta
# Edition: Community Edition

Start Using Neural Commander​

1. Run a Quick Audit​

cd /path/to/your/project

# Fast scan (recommended first time)
ncmd audit --quick

# Save report to markdown file
ncmd audit --quick -o

# Full scan (more thorough, takes longer)
ncmd audit

This scans your project for:

  • Documentation health
  • Git metrics
  • Code quality indicators (TODO/FIXME/HACK)
  • Requirements coverage

The -o flag saves a markdown report with auto-generated filename like 20260117-143022-projectname-audit.md.

2. Start the Daemon​

ncmd daemon start

The daemon enables:

  • Session monitoring
  • Real-time alerts
  • API server (port 7669)

3. View Admin Console​

ncmd admin

A terminal UI dashboard showing:

  • System status
  • Active sessions
  • Event stream

Press q to exit.

4. Check Claude Sessions​

If you use Claude Code:

ncmd claude-session list

Shows your Claude Code sessions with crash detection.

5. Chat with AI (Optional)​

# Requires Ollama running
ncmd chat "Write a Python function to reverse a string"

What's Next?​

Quick Tips​

  • NC works with zero configuration out of the box
  • Sessions persist across restarts - pick up where you left off
  • Use ncmd --help to see all available commands
  • The daemon runs in background for real-time project monitoring

Need help? Check our Troubleshooting Guide or submit feedback.