Add reader vorlagen (permissions, MCP, hooks, plugins, team AGENTS), humanizer skill, and adaptionen for ki-codex; refresh chapters 00–18, resource-path justfile, and dist PDF with full illustration set.
11 KiB
Kapitel 18
Anhang – Schnellreferenz
Kern: Spickzettel zum Nachschlagen beim Arbeiten – nicht Ersatz für die Kapitel 0–17.
So nutzen: Im echten Repo offen halten. Befehl/Pfad suchen → bei Unklarheit ins Kapitel springen. UI-Labels können mit Releases driften (Stand Juli–Aug 2026, CLI 0.2.x); grok --help, / und User-Guide bleiben autoritativ.
18.1 Install & Auth
| Plattform | Befehl |
|---|---|
| macOS/Linux/WSL/Git Bash | curl -fsSL https://x.ai/cli/install.sh | bash |
| Version pinnen | … | bash -s 0.2.0 (Beispiel-Pin; grok --version / Release-Notes) |
| Windows PowerShell | irm https://x.ai/cli/install.ps1 | iex |
| PS + Version | $env:GROK_VERSION="0.2.0"; irm https://x.ai/cli/install.ps1 | iex |
grok --version
grok update
grok doctor
grok doctor --json
grok login # default OAuth
grok login --device-auth # headless/remote
grok logout
export XAI_API_KEY="xai-..."
Credentials: ~/.grok/auth.json (owner-only). Details: Kapitel 2.
18.2 Start & Sessions
grok
grok "initial prompt"
grok --cwd ~/projects/app
grok -c # continue last
grok -r <session-id-or-title>
grok -m grok-build
grok --worktree=feat "…" # = verhindert Prompt-als-Name
grok -w --ref main "…"
grok --yolo / --always-approve
grok --sandbox workspace
grok --rules "…"
grok sessions list
grok sessions search "keyword"
grok sessions delete <id>
grok inspect
grok models
| TUI | Wirkung |
|---|---|
/new /clear |
neue Session |
/resume |
Session-Picker |
/rename |
Titel |
/fork [--worktree|--no-worktree] |
verzweigen |
/rewind (/undo) |
Turn + Files zurück |
/compact [hint] |
Kontext komprimieren |
/context |
Fenster-Breakdown |
/session-info /status |
Meta |
/quit /exit |
beenden |
/home |
Welcome |
18.3 Modes & Permissions
| Hebel | Wirkung |
|---|---|
Shift+Tab |
Normal → Plan → Always-approve |
Ctrl+O / /always-approve |
YOLO toggeln |
/auto |
Auto-Mode (Feature) |
/plan /view-plan |
Plan Mode |
--allow / --deny |
Rules |
[permission] in config |
Allow/Deny Listen |
Pipeline: Hooks → Deny > Ask > Allow → remembered grants → built-in readonly → Mode.
Deny gewinnt immer – auch unter Always-approve.
grok -p "…" --always-approve \
--deny 'Bash(rm -rf *)' \
--deny 'Bash(git push --force *)' \
--allow 'Bash(npm test *)'
Sandbox: --sandbox off|workspace|devbox|read-only|strict (Built-ins) oder Profilname aus sandbox.toml (z. B. --sandbox project).
Trust: /hooks-trust, --trust, ~/.grok/trusted_folders.toml.
Kapitel 4, 13.
18.4 Plan Mode Approval (Preview)
| Key | Aktion |
|---|---|
a |
Approve (+ comments) |
s |
Request changes |
c |
Comment on lines |
y |
Plan in Clipboard |
q |
Quit plan |
Tab |
Preview ↔ Prompt |
Plan-Datei: ~/.grok/sessions/<encoded-cwd>/<id>/plan.md.
18.5 TUI-Shortcuts (Alltag)
| Key | Aktion |
|---|---|
Tab |
Prompt ↔ Scrollback |
Enter |
senden |
Esc |
Turn cancel (Draft bleibt)* |
Ctrl+C |
clear/cancel-Semantik |
Ctrl+P / ? |
Palette |
Ctrl+M |
Model-Picker oder Multiline |
Ctrl+S |
Sessions |
Ctrl+T |
Todos |
Ctrl+G |
Tasks-Pane |
Ctrl+B |
Command backgrounden |
Ctrl+L / /plugins |
Extensions-Modal* |
Ctrl+. / Ctrl+X |
Shortcuts-Hilfe |
F2 |
Settings |
@ |
Datei anhängen |
! |
Shell-Mode |
↑ |
Prompt-History |
* Fullscreen+Vim: Esc cancelt oft nicht – Ctrl+C. Auf VS-Code-Familie ist Ctrl+L oft Interject – Extensions dort über /plugins / /hooks. Details: Kapitel 3.
18.6 Slash-Commands (Auswahl)
| Command | Zweck |
|---|---|
/plan /view-plan |
Plan Mode |
/model /m /effort |
Modell |
/always-approve /auto |
Permissions |
/compact /context |
Kontext |
/memory /flush /dream /remember |
Memory (default oft aus; /flush//dream//memory brauchen Opt-in – Kap. 12; /remember oft auch ohne) |
/hooks /plugins /marketplace /skills /mcps |
Extensions |
/config-agents /personas |
Agents |
/doctor |
Diagnose |
/goal /workflow /workflows |
Goals/Workflows |
/dashboard |
Agent-Dashboard (Fullscreen) |
/deep-research |
Background-Research-Workflow |
/loop |
wiederkehrend |
/btw |
Side-Question |
/create-skill |
Skill bauen |
/login /logout /usage /privacy |
Account |
/import-claude |
Claude-Settings importieren |
/imagine /imagine-video |
Media Generation |
/settings /theme |
UI |
/copy /export |
Export |
/minimal /fullscreen /vim-mode |
Render/Nav |
/tutorial /docs |
Hilfe |
Skills mit user-invocable: true → /skill-name. Qualifiziert: /local:name, /repo:name, /user:name, oder /<plugin-name>:skill.
18.7 Headless & ACP
# Headless
grok -p "prompt"
grok -p "…" --output-format plain|json|streaming-json|streaming-messages-json
# partial deltas nur mit streaming-messages-json:
# --include-partial-messages
grok -p "…" --tools "read_file,grep,list_dir"
grok -p "…" --disallowed-tools "Agent,web_search"
grok -p "…" --max-turns 30
grok -p --prompt-file ./p.txt
# ACP (Deny/Allow: [permission] in config – nicht als agent-CLI-Flag)
grok agent --always-approve stdio
grok agent --always-approve serve --bind 127.0.0.1:2419 --secret TOKEN
Kapitel 10–11.
18.8 Subagents & Worktrees
| Typ | Edits |
|---|---|
general-purpose |
ja |
explore |
nein |
plan |
nein |
Capability: read-only | read-write | execute | all.
Isolation: none | worktree.
TUI: Ctrl+G Tasks.
Disable: GROK_SUBAGENTS=0 / [subagents] enabled=false.
grok --worktree=label "…"
grok -w -r <session-id>
/fork --worktree …
Kapitel 5–6.
18.9 Pfade-Cheatsheet
| Was | Wo |
|---|---|
| User config | ~/.grok/config.toml |
| Project config | .grok/config.toml |
| Sandbox | ~/.grok/sandbox.toml, .grok/sandbox.toml |
| Auth | ~/.grok/auth.json |
| MCP OAuth | ~/.grok/mcp_credentials.json |
| Trust | ~/.grok/trusted_folders.toml |
| Sessions | ~/.grok/sessions/<cwd>/<id>/ |
| Memory | ~/.grok/memory/ |
| User skills | ~/.grok/skills/ |
| Project skills | .grok/skills/ |
| Hooks | ~/.grok/hooks/, .grok/hooks/ |
| Rules | .grok/rules/, AGENTS.md |
| Global rules | ~/.grok/rules/ |
$GROK_HOME |
Basis-Override |
Precedence: CLI > Env > config.toml > managed/requirements > defaults.
18.10 MCP (kurz)
grok mcp list
grok mcp add filesystem -- npx -y @modelcontextprotocol/server-filesystem ./docs
grok mcp add --transport http name https://… --header "Authorization: Bearer ${TOKEN}"
grok mcp enable name
grok mcp disable name
grok mcp doctor
grok mcp remove name
[mcp_servers.name]
command = "npx"
args = ["-y", "…"]
# oder url = "https://…"
enabled = true
Tools: server__tool via search_tool / use_tool. Modal: /mcps. Kapitel 9.
18.11 Prompt-Schablone
Ziel:
Nicht-Ziel:
Dateien:
Vorgehen: explore | plan | implement
Verify: <command>
Stop: kein push / warte auf ok
Compact:
/compact Behalte <Entscheidungen>. Verwirf <Explore-Müll>.
Kapitel 16.
18.12 Symptom → Fix (Mini)
| Symptom | Fix |
|---|---|
| command not found | PATH / reinstall |
| CI hängt | --always-approve + deny |
| Regeln greifen nicht | grok inspect, CWD |
| Kontext drift | /compact hint / /new |
| MCP tot | doctor, trust, enable |
.env im Kontext |
Deny Read(**/.env) (+ absolute Forms) |
| Keys tot in tmux | /doctor, Ctrl+X |
Voll: Kapitel 16.6.
18.13 Vorlagen & Beispiele
| Pfad | Inhalt |
|---|---|
vorlagen/AGENTS.md.minimal.md |
Minimal-Regeln |
vorlagen/AGENTS.md.team.md |
Team-Baseline |
vorlagen/config.toml.beispiel.toml |
Config-Skizze (User/Project) |
vorlagen/config.permissions.toml |
Permissions-Minimum |
vorlagen/config.mcp.toml |
MCP-Snippets |
vorlagen/PLAN.md.skeleton.md |
Plan-Skeleton |
vorlagen/hooks/, vorlagen/skills/, vorlagen/plugins/ |
Hooks, Verify, Plugin-Baseline |
beispiele/ |
Mitmach-Index |
ADAPTIONEN.md |
Schwesterprojekt-Mapping |
18.14 Glossar (Mini)
Einstieg auch in Kapitel 1.11.
| Begriff | Bedeutung |
|---|---|
| Harness | Tools, Permissions, Memory, Loop ums Modell |
| Tool-Call | Einzelner freigegebener Handlungsschritt (read/shell/edit/…) |
| Session | Ein Arbeitsgespräch inkl. Kontext und History |
| CWD | Working Directory – Startordner von grok |
| Diff | Änderungsansicht (+/−); vor Allow und vor Commit lesen |
| Plan Mode | Read-only Planung + Freigabe-UI |
| Compact | Kontext komprimieren (mit optionalem Keep-Hinweis) |
| Deny | Harte Block-Regel; gewinnt auch unter Always-approve |
| Subagent | Kind-Session, eigener Kontext |
| Worktree | Isolierte Git-Arbeitskopie |
| Skill | SKILL.md-Workflow, oft /name |
| Hook | Lifecycle-Script, kann deny |
| MCP | Externe Tools über Standardprotokoll |
| ACP | Agent Client Protocol (IDE/Server) |
| Always-approve | YOLO – Deny/Hooks bleiben |
| Folder-Trust | Gate für project MCP/Hooks/LSP |
18.15 Lesepfad (Recap)
Minimum (Anfänger, ~90–120 Min.): 00 → 01 skimmen → 02 (+ beispiele/todo-cli) → 03 Day-1 → diese Woche 04 + 07; optional 15.2 todo-cli-Variante. Siehe Vorwort „Anfänger-Lesepfad“.
- 00 Vorwort · 01 Philosophie
- 02 Install · 03 TUI
- 04 Plan · 05 Subagents · 06 Worktrees
- 07 AGENTS.md · 08 Skills/Hooks · 09 MCP
- 10 Headless · 11 ACP
- 12 Memory/Sessions · 13 Safety · 14 Config
- 15 Use-Cases · 16 BP/Troubleshoot · 17 Vergleich
Was du jetzt kannst
- Install, Sessions, Modes, Plan, Headless und Pfade ohne Suchen nachschlagen
- Symptom-Minis und Prompt-Schablone im Alltag einsetzen
- In die richtigen Kapitel zurückspringen
Nächste Schritte
Zurück in die Praxis: ein echtes Ticket mit Use-Case aus Kapitel 15 und der Schablone aus 18.11. Bei Lücken im Buch: Issue/PR am Repo – und immer die aktuelle CLI-Hilfe gegenlesen.