# CodeMate Documentation

## CodeMate Docs

- [Overview](https://docs.codemate.ai/overview.md)
- [Essentials](https://docs.codemate.ai/essentials.md)
- [What We Do](https://docs.codemate.ai/essentials/what-we-do.md)
- [Toolbox](https://docs.codemate.ai/toolbox.md): The unified desktop application that orchestrates the entire CodeMate ecosystem from AI coding assistants to your personal developer dashboard.
- [CORA](https://docs.codemate.ai/cora.md): Cora is CodeMate’s agentic architect mode that turns natural language prompts into complete, production-ready projects through intelligent planning and code generation.
- [Quickstart](https://docs.codemate.ai/cora/quickstart.md): Install Cora, open a project, and run your first prompt.
- [Modes](https://docs.codemate.ai/cora/modes.md): Cora operates in five modes. Each one is optimized for a different kind of task understanding, planning, building, or reviewing. You select the mode before sending a message, or let Auto decide for
- [Auto](https://docs.codemate.ai/cora/modes/auto.md): Orchestrator mode. Cora selects and sequences the appropriate modes based on what the prompt requires.
- [Marshal](https://docs.codemate.ai/cora/modes/marshal.md): The mode that plans, checks, builds, and verifies so nothing falls through the cracks.
- [Plan](https://docs.codemate.ai/cora/modes/plan.md): Produces architecture documents, stack decisions, and dependency-ordered task breakdowns. Does not write any code.
- [Ask](https://docs.codemate.ai/cora/modes/ask.md): Answers questions about your codebase and explains how things work. Never writes, modifies, or deletes files.
- [Code](https://docs.codemate.ai/cora/modes/code.md): Writes, modifies, and refactors code. The primary execution mode.
- [Review](https://docs.codemate.ai/cora/modes/review.md): Audits code changes for correctness, consistency, and architectural alignment. Does not write new code.
- [Configuration](https://docs.codemate.ai/cora/configuration.md): Cora's configuration lives on your local filesystem as plain text files. All settings skills, rules, workflows, MCP servers, system instructions, and auto-accept behavior can be read and edited direct
- [Skills](https://docs.codemate.ai/cora/configuration/skills.md): Markdown files that give Cora domain knowledge specific to your project, stack, or technical conventions.
- [Rules](https://docs.codemate.ai/cora/configuration/rules.md): Markdown files that define hard constraints Cora applies to every interaction, without exception.
- [Workflows](https://docs.codemate.ai/cora/configuration/workflows.md): Markdown files that define step-by-step processes for recurring tasks.
- [MCP servers](https://docs.codemate.ai/cora/configuration/mcp-servers.md): Connect external tools and services to Cora using the Model Context Protocol.
- [Auto-accept](https://docs.codemate.ai/cora/configuration/auto-accept.md): Controls whether Cora applies file changes automatically or waits for your confirmation before writing to disk.
- [Browser Agent](https://docs.codemate.ai/cora/configuration/browser-agent.md): Give CORA control of a browser navigate pages, interact with your running app, scrape content, and test UI flows, all from a natural language prompt.
- [C0](https://docs.codemate.ai/c0.md)
- [Quickstart](https://docs.codemate.ai/c0/quickstart.md): Get C0 installed, connected to your codebase, and running your first workflow in under five minutes.
- [Chat](https://docs.codemate.ai/c0/chat.md)
- [Knowledge Base](https://docs.codemate.ai/c0/knowledge-base.md): This page explains how the knowledge base works, how to extend it with your own knowledge, and how to keep it healthy over time.
- [Debug Code Agent](https://docs.codemate.ai/c0/debug-code-agent.md): Debug your code with the help of our debug agent.
- [Code Review Agent](https://docs.codemate.ai/c0/code-review-agent.md): Review your code with the help of our review agent.
- [Optimize Code Agent](https://docs.codemate.ai/c0/optimize-code-agent.md): Optimize your code with the help of our optimize agent.
- [Test Cases Agent](https://docs.codemate.ai/c0/test-cases-agent.md): Generate high quality test cases efficiently for your codebase.
- [Swagger Agent](https://docs.codemate.ai/c0/swagger-agent.md)
- [Deep Wiki](https://docs.codemate.ai/c0/deep-wiki.md): Deep Wiki generates rich, developer-grade documentation for any function, class, module, or system in your codebase. It doesn't just describe what code does it explains when and why to use it, what
- [Code Maps](https://docs.codemate.ai/c0/code-maps.md)
- [Jira Integration](https://docs.codemate.ai/c0/jira-integration.md): C0's Jira integration connects your tickets to your editor.
- [Build](https://docs.codemate.ai/build.md): Build your applications effortlessly with the help of our build agent.
- [Quickstart](https://docs.codemate.ai/build/quickstart.md): Build and deploy your first app. This guide walks through creating a project from scratch using conversational mode. By the end you'll have a running application at a public URL.
- [Conversational build](https://docs.codemate.ai/build/conversational-build.md): Generate a complete full-stack codebase from a plain-language description, then extend it incrementally through follow-up prompts.
- [Design mode](https://docs.codemate.ai/build/design-mode.md): Generate high-fidelity UI designs from a natural language description, then refine them before exporting to code.
- [Figma integration](https://docs.codemate.ai/build/figma-integration.md): Turn any Figma design into a working fullstack application. Paste a link, click Import, and Build clones your design into production-ready code.
- [Deployment](https://docs.codemate.ai/build/deployment.md): Publish your app to a managed cloud environment and get a shareable public URL in seconds.
- [Writing prompts](https://docs.codemate.ai/build/writing-prompts.md): How to write initial and follow-up prompts that produce better output.
- [Iterative building](https://docs.codemate.ai/build/iterative-building.md): How to build complex applications incrementally without overloading a single prompt.
- [Community spotlight](https://docs.codemate.ai/build/community-spotlight.md): A curated gallery of real apps built by the CodeMate community, with live demos and cloneable templates.
- [CodeMate for Education](https://docs.codemate.ai/codemate-for-education.md)
- [For Students](https://docs.codemate.ai/codemate-for-education/for-students.md)
- [For Institutions](https://docs.codemate.ai/codemate-for-education/for-institutions.md): Transform how your programs teach modern software development.
- [Campus Clubs and Ambassadors](https://docs.codemate.ai/codemate-for-education/campus-clubs-and-ambassadors.md): Lead your campus. Build community. Shape the future of coding education.
- [Apply to CodeMate for Education](https://docs.codemate.ai/codemate-for-education/apply-to-codemate-for-education.md): Get started in minutes. Access begins immediately upon verification.
- [Courses](https://docs.codemate.ai/codemate-for-education/courses.md)
- [Frequently Asked Questions](https://docs.codemate.ai/codemate-for-education/frequently-asked-questions.md): Answers to the most common questions about CodeMate for Education
- [Pull Request Review Agent](https://docs.codemate.ai/pull-request-review-agent.md): Integrated with your version control (Github/Bitbucket/Gitlab/Azure-devops).
- [CodeMate Terminal](https://docs.codemate.ai/codemate-terminal.md)
- [FAQ's](https://docs.codemate.ai/codemate-terminal/faqs.md)
- [Feature walkthrough](https://docs.codemate.ai/feature-walkthrough.md)
- [VS Code Extension](https://docs.codemate.ai/feature-walkthrough/vs-code-extension.md)
- [CodeMate Web App](https://docs.codemate.ai/feature-walkthrough/codemate-web-app.md)
- [CodeMate for Education](https://docs.codemate.ai/feature-walkthrough/codemate-for-education.md)
- [CodeMate Terminal](https://docs.codemate.ai/feature-walkthrough/codemate-terminal.md)
- [Platforms](https://docs.codemate.ai/platforms.md)
- [Enterprise](https://docs.codemate.ai/enterprise.md)
- [Deployment](https://docs.codemate.ai/enterprise/deployment.md)
- [Plans & Billing](https://docs.codemate.ai/plans-and-billing.md): Access the complete CodeMate ecosystem powering every step of your SDLC, from idea to deployment.
- [Product Changelog](https://docs.codemate.ai/product-changelog.md)
- [VS Code Extension Changelog](https://docs.codemate.ai/product-changelog/vs-code-extension-changelog.md): Complete changelog of CodeMate VS Code Extension.
- [Troubleshooting & FAQs](https://docs.codemate.ai/troubleshooting-and-faqs.md)
- [Policies](https://docs.codemate.ai/policies.md)
- [Terms of Service](https://docs.codemate.ai/policies/terms-of-service.md)
- [Privacy Policy](https://docs.codemate.ai/policies/privacy-policy.md): Our promise to protecting your privacy
- [Refund Policy](https://docs.codemate.ai/policies/refund-policy.md)
- [Fair Usage Policy](https://docs.codemate.ai/policies/fair-usage-policy.md)
- [Community Guidelines](https://docs.codemate.ai/policies/community-guidelines.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.codemate.ai/overview.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
