Skip to content

Commit 2d0e513

Browse files
committed
docs: sync CLI commands and provider list with current code
- cli-commands.md: remove non-existent 'auth' command; add missing subcommands (init, bridge, doctor, encrypt, mcp-server, session, cert) to overview, summary table, and examples to match the Commands enum in cli/mod.rs - intro.md: add xAI, Vertex AI, Gemini CLI, Codex CLI to the multi-provider bullet and Supported Models table; refresh outdated model examples (claude-opus-4-5 -> claude-opus-4-6) and aliases (glm, grok, codex) - configuration.md: extend alias comment with glm/grok/codex; fix codex_cli default model (gpt-4o -> o4-mini) to match the schema default
1 parent 03dc0f2 commit 2d0e513

3 files changed

Lines changed: 48 additions & 16 deletions

File tree

website/docs/cli-commands.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,25 @@ Commands:
1818
gen Launch world generation mode (Bevy renderer)
1919
daemon Manage the background daemon
2020
memory Memory management operations
21-
search Test web search provider
22-
auth Authenticate with providers
2321
config Configuration management
2422
md Manage LocalGPT.md standing instructions
25-
sandbox Shell sandbox diagnostics
2623
paths Show resolved directory paths
27-
desktop Launch desktop GUI
24+
sandbox Shell sandbox diagnostics
25+
search Test and manage web search
26+
init Initialize configuration and keys
27+
bridge Manage bridges and credentials
28+
doctor Run diagnostics to validate setup
29+
encrypt Manage encryption at rest
30+
tool Manage MCP tool servers
31+
plugin Manage MCP tool servers (alias for 'tool')
2832
completion Generate shell completion scripts
2933
cron Manage cron jobs
3034
hooks Manage lifecycle hooks
31-
tool Manage MCP tool servers
32-
plugin Manage MCP tool servers (alias for 'tool')
35+
mcp-server Run as MCP server (stdio) exposing memory tools
36+
session Manage sessions (list, branch, checkpoints)
3337
audit View and verify compaction audit log
38+
cert Manage TLS certificates (info, regenerate)
39+
desktop Launch desktop GUI (feature-gated)
3440
help Print help information
3541
```
3642

@@ -58,18 +64,24 @@ Options:
5864
| [`gen`](/docs/gen) | Launch world generation mode (Bevy renderer) |
5965
| [`daemon`](/docs/cli-daemon) | Start/stop/status of the background daemon |
6066
| [`memory`](/docs/cli-memory) | Search, reindex, and manage memory |
61-
| `search` | Test web search provider configuration |
62-
| `auth` | Authenticate with providers (Gemini, etc.) |
6367
| `config` | Init, show, get, and set configuration values |
6468
| [`md`](/docs/localgpt#quick-reference) | Sign, verify, and audit LocalGPT.md |
65-
| [`sandbox`](/docs/sandbox#cli-commands) | Inspect sandbox capabilities and run tests |
6669
| `paths` | Show resolved XDG directory paths |
70+
| [`sandbox`](/docs/sandbox#cli-commands) | Inspect sandbox capabilities and run tests |
71+
| `search` | Test and manage web search providers |
72+
| `init` | Initialize configuration and device keys |
73+
| `bridge` | Manage chat bridges and credentials |
74+
| `doctor` | Run diagnostics to validate setup (config, keys, providers) |
75+
| `encrypt` | Manage encryption at rest (sessions, config secrets) |
6776
| `desktop` | Launch the native desktop GUI (egui) |
6877
| `completion` | Generate shell completion scripts (bash, zsh, fish) |
6978
| `cron` | Manage cron jobs (list, add, remove) |
7079
| `hooks` | Manage lifecycle hooks |
7180
| `tool` / `plugin` | Manage MCP tool servers (list, add, remove, enable, disable) |
81+
| `mcp-server` | Run as an MCP server (stdio) exposing memory tools |
82+
| `session` | Manage sessions (list, branch, compaction checkpoints) |
7283
| `audit` | View and verify compaction audit log (show, verify, stats) |
84+
| `cert` | Manage TLS certificates (info, regenerate) |
7385

7486
## Examples
7587

@@ -116,8 +128,11 @@ localgpt-gen "create a solar system with planets"
116128
# Test web search provider
117129
localgpt search test
118130

119-
# Authenticate with Google Gemini
120-
localgpt auth gemini
131+
# Initialize config and device keys (first-time setup)
132+
localgpt init
133+
134+
# Run setup diagnostics (config, keys, providers, MCP)
135+
localgpt doctor
121136

122137
# Show resolved directory paths
123138
localgpt paths
@@ -149,6 +164,19 @@ localgpt audit show --limit 5 # Show last 5 events
149164
localgpt audit show --json # JSON output
150165
localgpt audit verify # Verify hash chain integrity
151166
localgpt audit stats # Show compaction statistics
167+
168+
# Session management and compaction checkpoints
169+
localgpt session list # List recent sessions
170+
localgpt session branch <session-id> # Branch a session into a new one
171+
localgpt session checkpoints # List checkpoints for the latest session
172+
localgpt session restore 2 # Restore latest session from checkpoint #2
173+
174+
# Run as an MCP server (stdio) for external AI backends
175+
localgpt mcp-server
176+
177+
# Manage TLS certificates for the HTTP server
178+
localgpt cert info # Show certificate expiry, SANs, and paths
179+
localgpt cert regenerate # Force certificate regeneration
152180
```
153181

154182
## Built-in Chat Commands

website/docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ EOF
5252
# xai/* → xAI (Grok)
5353
# glm/* or glm → GLM (Z.AI)
5454
# ollama/* → Ollama
55-
# Aliases: opus, sonnet, gpt, gpt-mini
55+
# Aliases: opus, sonnet, gpt, gpt-mini, glm, grok, codex
5656
default_model = "claude-cli/opus"
5757

5858
# Context window size (in tokens)
@@ -103,7 +103,7 @@ model = "gemini-3.1-pro-preview"
103103

104104
[providers.codex_cli]
105105
command = "codex"
106-
model = "gpt-4o"
106+
model = "o4-mini"
107107

108108
[providers.openai_compatible]
109109
# Generic OpenAI-compatible endpoint (OpenRouter, DeepSeek, etc.)

website/docs/intro.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ LocalGPT is a **local AI assistant with persistent memory, semantic search, and
1313
- **Hybrid Memory Search** - Markdown-based knowledge store with pluggable backends (SQLite FTS5, Markdown grep, or disabled). SQLite backend supports full-text search with AND matching and rank-based scoring plus local vector embeddings (fastembed) for semantic search
1414
- **Desktop App** - Optional native desktop GUI built with egui — chat, sessions, memory browser, and status dashboard. Disable with `--no-default-features` for headless/Docker deployments.
1515
- **Embedded Web UI** - Browser-based chat interface served directly from the binary
16-
- **Multi-Provider Support** - Works with Claude CLI, Anthropic API, OpenAI, Ollama, and GLM (Z.AI) — all with full tool calling support
16+
- **Multi-Provider Support** - Works with Claude CLI, Anthropic API, OpenAI, Ollama, GLM (Z.AI), xAI (Grok), Google Vertex AI, Gemini CLI, and Codex CLI — all with full tool calling support
1717
- **Telegram, Discord & WhatsApp** - Access LocalGPT from Telegram, Discord, or WhatsApp via bridge binaries with full chat, tool use, and memory support — secured with one-time pairing auth
1818
- **Autonomous Heartbeat** - Daemon mode with scheduled background tasks that run automatically
1919
- **Skills System** - Extensible skills for specialized tasks
@@ -92,9 +92,13 @@ LocalGPT automatically detects the provider based on model name prefix:
9292
| `openai/*` | LM Studio / OpenAI | openai/qwen/qwen3.5-35b-a3b, openai/gpt-4o |
9393
| Other | Ollama (local) | llama3, mistral, codellama |
9494
| `claude-cli/*` | Claude CLI | claude-cli/opus, claude-cli/sonnet |
95-
| `anthropic/*` | Anthropic API | anthropic/claude-opus-4-5, anthropic/claude-sonnet-4-5 |
95+
| `gemini-cli/*` | Gemini CLI | gemini-cli/gemini-2.5-pro |
96+
| `codex-cli/*` | Codex CLI | codex-cli/o4-mini |
97+
| `anthropic/*` | Anthropic API | anthropic/claude-opus-4-6, anthropic/claude-sonnet-4-6 |
98+
| `xai/*` | xAI (Grok) | xai/grok-3-mini |
99+
| `vertex/*` | Google Vertex AI | vertex/gemini-2.5-pro |
96100
| `glm/*` or `glm` | GLM (Z.AI) | glm/glm-4.7, glm |
97-
| Aliases | Any | opus, sonnet, gpt, gpt-mini |
101+
| Aliases | Any | opus, sonnet, gpt, gpt-mini, glm, grok, codex |
98102

99103
## Next Steps
100104

0 commit comments

Comments
 (0)