Help

Kimix Help

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

Steps

1. If the question is about current config (what MCP servers, models, or settings are active), read ~/.kimix/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 ~/.kimix/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
   • 22-permissions-and-safety.md -- Permission modes, auto-approve, restrictive hooks
   • 23-dashboard.md -- Multi-session dashboard, peek, attach, dispatch
   • 24-monitoring-usage.md -- OpenTelemetry usage export
   • 25-building-extensions.md -- Author plugins / hooks / slash / skills / MCP ("mods") Read the relevant guide(s) for the user's question. If none match, fall back to ~/.kimix/README.md for the comprehensive reference.

   For how Kimix works as a product (architecture, extension surface, doc map), load /kimix-knowledge. To build a plugin/hook/slash/MCP package, load /mod-builder and follow 25-building-extensions.md.

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

4. To create a skill for the user, create ~/.kimix/skills/<name>/SKILL.md (read ~/.kimix/docs/user-guide/08-skills.md for the SKILL.md format). For a full plugin/hook/MCP package (Kimix "mod"), use /mod-builder instead.