Skip to main content

CLI Commands

LocalGPT provides a comprehensive command-line interface with several subcommands.

Overview

localgpt <COMMAND>

Commands:
chat Interactive multi-turn conversation
ask Single question and response
gen Launch world generation mode (Bevy renderer)
daemon Manage the background daemon
memory Memory management operations
search Test web search provider
auth Authenticate with providers
config Configuration management
md Manage LocalGPT.md standing instructions
sandbox Shell sandbox diagnostics
paths Show resolved directory paths
desktop Launch desktop GUI
help Print help information

Global Options

localgpt [OPTIONS] <COMMAND>

Options:
-c, --config <PATH> Path to config file (default: ~/.config/localgpt/config.toml)
-a, --agent <ID> Agent ID (default: "main")
-m, --model <MODEL> Override the default model
-v, --verbose Enable verbose logging
-h, --help Print help
-V, --version Print version

Command Summary

CommandDescription
chatInteractive multi-turn conversation with session support
askSingle-turn question answering
genLaunch world generation mode (Bevy renderer)
daemonStart/stop/status of the background daemon
memorySearch, reindex, and manage memory
searchTest web search provider configuration
authAuthenticate with providers (Gemini, etc.)
configInit, show, get, and set configuration values
mdSign, verify, and audit LocalGPT.md
sandboxInspect sandbox capabilities and run tests
pathsShow resolved XDG directory paths
desktopLaunch the native desktop GUI (egui)

Examples

# Start an interactive chat
localgpt chat

# Ask a single question
localgpt ask "What is the capital of France?"

# Use a specific model
localgpt -m anthropic/claude-sonnet-4-5 chat

# Start the daemon
localgpt daemon start

# Search memory
localgpt memory search "project ideas"

# Show memory statistics
localgpt memory stats

# Configuration management
localgpt config init # Create default config
localgpt config show # Display loaded config
localgpt config get agent.default_model # Get a specific value
localgpt config set agent.default_model "claude-cli/opus"

# Check sandbox capabilities
localgpt sandbox status

# Sign LocalGPT.md after editing
localgpt md sign

# View security audit log
localgpt md audit

# Launch world generation (separate binary)
localgpt-gen "create a solar system with planets"

# Test web search provider
localgpt search test

# Authenticate with Google Gemini
localgpt auth gemini

# Show resolved directory paths
localgpt paths

Built-in Chat Commands

When in interactive chat mode, these commands are available:

CommandDescription
/help, /h, /?Show help for chat commands
/quit, /exit, /qExit the chat session
/newStart a fresh session
/sessionsList saved sessions
/resume <id>Resume a saved session
/search <query>Search across sessions
/memory <query>Search memory for a term
/saveForce save current context to memory
/compactManually trigger session compaction
/model [name]Show or switch the current model
/modelsList available model prefixes
/contextShow context window usage
/statusShow session status (tokens, turns)
/export [file]Export session as markdown
/attach <file>Attach a file to the conversation
/clearClear the terminal screen
/skillsList available skills

Additionally, any installed skills can be invoked via /skill-name (e.g., /commit, /github-pr). See Skills System for details.

Exit Codes

CodeMeaning
0Success
1General error
2Configuration error
3API/Provider error