Skip to main content

CLI Reference

Neural Commander provides a comprehensive CLI for project health scanning and AI orchestration.

Audit Commands​

The audit command is the core of Neural Commander, providing comprehensive project health analysis.

Basic Usage​

# Audit current directory
ncmd audit

# Audit specific path
ncmd audit /path/to/project

# Quick scan (fast, <30s target)
ncmd audit --quick

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

Output Options​

# Summary output (default)
ncmd audit

# Full markdown report to stdout
ncmd audit --format markdown

# JSON output for programmatic use
ncmd audit --format json

# Save markdown to file (auto-generated filename)
ncmd audit -o
# Creates: YYYYMMDD-HHMMSS-projectname-audit.md

# Save to specific directory
ncmd audit -o ./reports/

# Save to specific filename
ncmd audit -o my-audit-report.md

Scan Options​

# Quick scan - skips heavy directories, max depth 5
ncmd audit --quick

# Focus on subdirectory
ncmd audit --focus neural-commander-go

# Include external repositories
ncmd audit --include-external

# Verbose output
ncmd audit -v
ncmd audit --verbose

# Don't save to .audit/ directory
ncmd audit --save=false

Combining Options​

# Quick scan with markdown export
ncmd audit --quick -o

# Full scan focused on subdirectory, save report
ncmd audit --focus src -o ./reports/

# Verbose JSON output
ncmd audit -v --format json

Session Commands​

# List all sessions
ncmd session list

# Show session details
ncmd session show <session-id>

# Resume a session
ncmd session resume <session-id>

Claude Session Commands​

# List Claude Code sessions
ncmd claude-session list

# Show crashed sessions
ncmd claude-session list --crashed

# Resume crashed session
ncmd claude-session resume <session-id>

Daemon Commands​

# Start background daemon
ncmd daemon start

# Stop daemon
ncmd daemon stop

# Check daemon status
ncmd daemon status

Other Commands​

# Show version
ncmd version

# Show help
ncmd help
ncmd --help

# Chat with AI (requires Ollama)
ncmd chat "Your prompt here"
ncmd chat --stream "Your prompt"

Global Flags​

These flags work with all commands:

FlagDescription
--help, -hShow help for command
--versionShow version

Environment Variables​

VariableDescriptionDefault
NC_DATA_DIRData directory~/.neural-commander
OLLAMA_HOSTOllama API endpointhttp://localhost:11434

Exit Codes​

CodeMeaning
0Success
1General error
2Invalid arguments

For more details on specific features, see the Features documentation.