bingshuo/grok-build-upstream-mirror
Watch
1
0
Fork
You've already forked grok-build-upstream-mirror
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
grok-build-upstream-mirror/crates/codegen/xai-grok-shell/skills/help/SKILL.md
grokkybara[bot] c68e39f604 Publish harness and TUI open-source 
initial sync from the monorepo
2026-07-16 06:46:02 +01:00

2.4 KiB
Raw Blame History

name description metadata
help Grok documentation and configuration help. Use when users ask about setup, configuration, MCP servers, authentication, skills, slash commands, keyboard shortcuts, or any Grok feature. Also use proactively when you detect a user is having trouble with setup or onboarding.
short-description
Grok docs — config, MCP, auth, skills, commands

Grok Help

Answer the user's question about Grok setup, configuration, or features.

Steps

  1. If the question is about current config (what MCP servers, models, or settings are active), read ~/.grok/config.toml. MCP servers are under [mcp_servers.*] sections.

  2. If the question is about how to do something (setup, adding MCP servers, creating skills, authentication, keyboard shortcuts, troubleshooting), first check the user-guide docs at ~/.grok/docs/user-guide/. The available guides are:

    • 01-getting-started.md -- Installation, first launch, basic interaction
    • 02-authentication.md -- Browser login, API keys, OIDC, external auth
    • 03-keyboard-shortcuts.md -- Complete key bindings reference
    • 04-slash-commands.md -- All / commands
    • 05-configuration.md -- config.toml, pager.toml, env vars
    • 06-theming.md -- Themes, appearance customization
    • 07-mcp-servers.md -- MCP server setup and management
    • 08-skills.md -- Creating and using skills
    • 09-plugins.md -- Plugin marketplace
    • 10-hooks.md -- Lifecycle hooks
    • 11-custom-models.md -- BYOK, Ollama, OpenAI endpoints
    • 12-project-rules.md -- AGENTS.md project rules
    • 13-memory.md -- Cross-session memory
    • 14-headless-mode.md -- CLI scripting and CI/CD
    • 15-agent-mode.md -- ACP/stdio IDE integration
    • 16-subagents.md -- Subagents and personas
    • 17-sessions.md -- Session management
    • 18-sandbox.md -- Sandbox mode
    • 19-plan-mode.md -- Plan mode
    • 20-background-tasks.md -- Background tasks and monitoring
    • 21-terminal-support.md -- tmux, SSH, truecolor, clipboard, /terminal-setup Read the relevant guide(s) for the user's question. If none match, fall back to ~/.grok/README.md for the comprehensive reference.

  3. To modify config for the user, edit ~/.grok/config.toml with search_replace.

  4. To create a skill for the user, create ~/.grok/skills/<name>/SKILL.md (read ~/.grok/docs/user-guide/08-skills.md for the SKILL.md format).