Skip to content
MatchaCode
  • Features
  • Use cases
  • CLI
  • Download
  • 中文
Contents
  1. 00. How to Read This Documentation
    1. Three ways to run Matcha
    2. Fullscreen vs minimal
    3. Live catalog vs written tutorial
    4. Supported platforms
    5. Names, paths, and providers
  2. 01. Install, Credentials, and First Success
    1. Build from source
    2. Configure a Provider (BYOK)
    3. First launch and the welcome screen
    4. Inspect what Matcha discovered
    5. Quit and restore the terminal
  3. 02. Everyday Conversation and the Screen
    1. Send, queue, and cancel
    2. Read one screen
    3. Find, jump, and timeline
    4. Copy, transcript, and edit the prompt
    5. Screen and input modes
    6. Where commands come from
  4. 03. Giving the Assistant Context
    1. Attach files with @
    2. Paste and chips
    3. Images
    4. Change directory
    5. Project rules and imports
  5. 04. Models and Effort
    1. Switch models
    2. Reasoning effort
    3. Custom endpoints
    4. Local usage
  6. 05. Permissions, Plan Mode, and Safety
    1. The first permission prompt
    2. Ask, auto, and always-approve
    3. Plan before it acts
    4. Sandbox
    5. Permission rules and hook blocks
  7. 06. Sessions
    1. New, resume, rename, delete
    2. Compact and rewind
    3. Ask aside with /btw
    4. Export locally
    5. Session metadata
  8. 07. Parallel Work
    1. Fork a session
    2. Git worktrees
    3. Assistant dashboard
    4. Sub-assistants and personas
    5. Background tasks, queue, and loops
  9. 08. Extending Matcha
    1. Local MCP servers
    2. Skills
    3. Local plugins
    4. Hooks
    5. Memory
    6. Goals, workflows, and deep research
    7. Coming from another tool
  10. 09. Automation and Editor Integration
    1. Headless and CI
    2. ACP / stdio
    3. Clipboard wrap
    4. Leader processes
  11. 10. Configuration, Themes, and Terminals
    1. Files and environment variables
    2. Themes
    3. Settings
    4. Terminal support
    5. Disk usage
  12. 11. Diagnostics
    1. Doctor and inspect
    2. Local usage and release notes
    3. Common failures
  13. Appendix
    1. A. Mode A unavailable surfaces
    2. B. Slash command catalog
    3. C. CLI catalog
    4. D. Keyboard shortcuts
    5. E. Migrating from Grok Build

Contents

  1. 00. How to Read This Documentation
    1. Three ways to run Matcha
    2. Fullscreen vs minimal
    3. Live catalog vs written tutorial
    4. Supported platforms
    5. Names, paths, and providers
  2. 01. Install, Credentials, and First Success
    1. Build from source
    2. Configure a Provider (BYOK)
    3. First launch and the welcome screen
    4. Inspect what Matcha discovered
    5. Quit and restore the terminal
  3. 02. Everyday Conversation and the Screen
    1. Send, queue, and cancel
    2. Read one screen
    3. Find, jump, and timeline
    4. Copy, transcript, and edit the prompt
    5. Screen and input modes
    6. Where commands come from
  4. 03. Giving the Assistant Context
    1. Attach files with @
    2. Paste and chips
    3. Images
    4. Change directory
    5. Project rules and imports
  5. 04. Models and Effort
    1. Switch models
    2. Reasoning effort
    3. Custom endpoints
    4. Local usage
  6. 05. Permissions, Plan Mode, and Safety
    1. The first permission prompt
    2. Ask, auto, and always-approve
    3. Plan before it acts
    4. Sandbox
    5. Permission rules and hook blocks
  7. 06. Sessions
    1. New, resume, rename, delete
    2. Compact and rewind
    3. Ask aside with /btw
    4. Export locally
    5. Session metadata
  8. 07. Parallel Work
    1. Fork a session
    2. Git worktrees
    3. Assistant dashboard
    4. Sub-assistants and personas
    5. Background tasks, queue, and loops
  9. 08. Extending Matcha
    1. Local MCP servers
    2. Skills
    3. Local plugins
    4. Hooks
    5. Memory
    6. Goals, workflows, and deep research
    7. Coming from another tool
  10. 09. Automation and Editor Integration
    1. Headless and CI
    2. ACP / stdio
    3. Clipboard wrap
    4. Leader processes
  11. 10. Configuration, Themes, and Terminals
    1. Files and environment variables
    2. Themes
    3. Settings
    4. Terminal support
    5. Disk usage
  12. 11. Diagnostics
    1. Doctor and inspect
    2. Local usage and release notes
    3. Common failures
  13. Appendix
    1. A. Mode A unavailable surfaces
    2. B. Slash command catalog
    3. C. CLI catalog
    4. D. Keyboard shortcuts
    5. E. Migrating from Grok Build
  1. Documentation
  2. /Matcha CLI
  3. /01. Install, Credentials, and First Success

01

Install, Credentials, and First Success

  • Build from source
  • Configure a Provider (BYOK)
  • First launch and the welcome screen
  • Inspect what Matcha discovered
  • Quit and restore the terminal

MatchaCode

深圳简界智元科技有限公司Shenzhen Jianjiezhiyuan Technology Co. Ltd.

© 2026 Shenzhen Jianjiezhiyuan Technology Co. Ltd..

Site

  • Documentation
  • Use cases
  • Changelog
  • Newsroom

Legal

  • Privacy
  • Terms

MatchaCode is not an xAI, SpaceXAI, or Grok product, and it is not endorsed by those organizations.