# Overview

**On this page**

* [What is CodeMate?](#what-is-codemate)
* [What sets CodeMate apart?](#what-sets-codemate-apart)
* [What data is collected and how it's used?](#what-data-is-collected-and-how-its-used)
* [Join our community](#join-our-community)

## What is CodeMate

CodeMate is an AI-native SDLC agent that understands your entire codebase and automates research, prototyping, development, testing and reviewing across the software lifecycle.

Unlike traditional coding assistants that operate on isolated files or prompts, CodeMate builds a persistent understanding of your codebase and product documentation. This enables it to identify logical, syntax, and runtime issues, suggest fixes, and generate improvements with full system context similar to autocorrect, but for entire codebases.

CodeMate reduces hours of manual debugging, code review, and test creation into minutes through intelligent, context-aware suggestions. It supports tasks such as error fixing, code review, optimization, test case generation, and backend scaffolding via its Swagger agent.

It integrates seamlessly with IDEs such as VS Code and JetBrains, also platforms like GitHub, GitLab, Bit Bucket fitting directly into existing developer workflows.

CodeMate has onboarded **500,000+ users** across **52+ countries** on six continents, with strategic partnerships across hardware, cloud, and enterprise sectors.

### What sets CodeMate apart?

**Unmatched Code Understanding:**

* **AI-driven technology:** CodeMate goes deep into your entire codebase, understanding not only the lines of code but also the context and intent behind them. This allows it to understand the intricate relationships between different aspects of your code and identify even the most subtle & logical errors.
* **Vast knowledge base:** Beyond your codebase, CodeMate taps into a vast reservoir of open-source code and your organization's internal knowledge base. This gives it access to a wealth of information that further enhances its ability to solve complex problems and suggest optimal solutions.
* **Extensive training data:** CodeMate is constantly learning and evolving thanks to its access to massive amounts of code & related data. This allows it to identify patterns and trends, anticipate potential issues, and continuously improve its accuracy and effectiveness.

**A glimpse of the Feature Set:**

* **Agentic Coding:** Unlike other Agentic coding tools, CORA is designed specifically to write enterprise level production code with AI guardrails. This can be achieved by our suite of in-house LLMs that are trained specifically for code generation, code reviewing, debugging and context awareness.
* **Code Review:** After code generation, comes the most important part of code review before it is pushed to the production, CORA and C0 help you detect security vulnerabilities, issues in code quality and code understanding. After finding the vulnerabilities, CodeMate fixes it and tests it again to make sure every part of the code is ready to be pushed to prod.
* **Integrations:** Enterprises and teams all over the globe use Jira for managing agile software development, tracking issues, and streamlining workflows across various departments. CodeMate's suite of products integrate with Jira and enables teams move faster and efficiently over their entire software development life cycle. Along, with that CORA and C0 are integrated with IDEs such as VS code and JetBrains, this allows dev teams to move with out changing their existing workflow.
* **Utilities:** Currently in the version-3.5, CORA has support of [MCP servers](/cora/configuration/mcp-servers), [Skills](/cora/configuration/skills), [Rules](/cora/configuration/rules) and other utilities that boosts developer productivity without leaving their work space. In the recent release, C0 has now capabilities of [CodeMaps](/c0/code-maps) and [DeepWiki](/c0/deep-wiki).&#x20;

### What Data is Collected and How It's Used?

CodeMate collects and uses data responsibly and transparently. We are committed to protecting your privacy and security, and we take all necessary precautions to ensure that your data is handled securely.

Here's a breakdown of the data we collect and how it's utilized:

1\. **Prompts and responses**: When you use CodeMate, it collects your prompts and responses and it gets stored for 30 seconds in our systems in encrypted format. CodeMate never access or use any of your data to train models.&#x20;

2\. Usage data and feedback: We also collect general usage data such as the features you use and the time you spend using CodeMate. This data is used to:

* Track overall usage: We monitor how CodeMate is being used to identify trends and improve the platform.
* Troubleshoot issues: We use usage data to diagnose and fix any technical problems that may arise.
* Develop new features: We use user feedback and usage patterns to identify new features that would be valuable to our users.

If you wish to opt out to any of the collected data, You may opt out of it by mailing us at <contact@codemate.ai>.

[Read more about CodeMate Usage and Privacy policy here →](https://docs.codemate.ai/policies/privacy-policy)

### Join Our Community

CodeMate is more than just a tool; it's a community of developers who are passionate about coding and committed to helping each other succeed.

By joining our community, you can:

* Connect with other CodeMate users: Share your experiences, ask questions, and get help from fellow developers.
* Get access to exclusive content: Learn about new features, tips, and tricks for using CodeMate effectively.
* Contribute to the development of CodeMate: Share your feedback and suggestions to help shape the future of the product.
* Get support: Raise a support ticket & our team will get in touch to fix the issue.
* Participate in fun activities and events: Join coding challenges, hackathons, and other community events.

Stay connected with our community:

* Follow us on social media:
  * [Twitter](https://twitter.com/codemateai)
  * [Instagram](https://instagram.com/codemateai)
  * [LinkedIn](https://www.linkedin.com/company/codemateai/)
  * [YouTube](https://www.youtube.com/@codemateai)

We look forward to seeing you there!


# Essentials

### What is CodeMate?

CodeMate is an on-device AI agent for the Software Development Lifecycle (SDLC). It runs entirely within your developer environment and is equipped with built-in Responsible AI safeguards meaning your code and organizational knowledge never leave your machine.

***

### Who Should Use CodeMate?

CodeMate is built for:

* **Individual developers** who want AI assistance that understands their codebase deeply, not just the file they have open.
* **Engineering teams** that need consistent code quality, shared standards enforcement, and faster onboarding for new members.
* **Enterprises** that require on-premise or VPC deployment, governance guardrails, and security compliance built into their AI tooling.
* **Students, educators, and institutions** looking to close the gap between academic learning and industry-ready development practices.

***

### Why CodeMate?

Two problems slow down most software teams today:

* **66%** of developers cite "almost correct" AI suggestions as their biggest time sink.
* **72%** of developers take 1–2 months to make meaningful contributions to a large, unfamiliar codebase.

The root cause isn't the AI model it's the lack of context. Most tools don't understand your project's structure, your team's patterns, or your personal coding style. CodeMate solves this with a suite of products that build and maintain that context continuously, all orchestrated through a single desktop application.

***

### Products

CodeMate is a suite of products covering the entire development lifecycle, tied together by **Toolbox** the central orchestration layer that runs on your machine.

| Product                                                                       | Description                                                                                                         | Link                                                                                     |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| **Toolbox**                                                                   | The central hub that launches, coordinates, and manages all CodeMate products from a single desktop app             | [Learn more](https://app.codemate.ai/download)                                           |
| **CORA**                                                                      | Autonomous coding agent that converts natural language prompts into structured, dependency-aware execution plans    | [Learn more](https://app.codemate.ai/download)                                           |
| **C0**                                                                        | Deep codebase intelligence for reviews, debugging, and test case generation                                         | [Learn more](https://marketplace.visualstudio.com/items?itemName=AyushSinghal.Code-Mate) |
| **Build**                                                                     | Convert Figma designs, prompts, and BRD files into working MVPs                                                     | [Learn more](https://build.codemateai.dev/build)                                         |
| <p><strong>PR Review Agent</strong><br><strong>(Enterprise Only)</strong></p> | Automated pull request checks and code reviews before production                                                    | [Learn more](/pull-request-review-agent)                                                 |
| **CodeMate for Education**                                                    | AI-powered development tools for students, educators, and institutions with offline support and free academic plans | [Learn More](https://edu.codemate.ai/)                                                   |

> **Start with Toolbox.** It runs the local subsystem process that powers C0 and CORA in your IDE, manages authentication across all products.
>
> Download it at [app.codemate.ai/download](https://app.codemate.ai/download).

***

### Key Differentiators

**Local-First:** CodeMate runs entirely on the developer's machine via the Toolbox subsystem. No data is sent to external servers, giving you full on-device privacy.

**Persistent Organisational Memory:** Unlike tools that reset context each session, CodeMate retains memory across sessions understanding team style, dependency trees, and project history.

**Responsible AI Built-In:** Every workflow includes governance guardrails and security checks, not as an afterthought, but as a core part of the system.

**Enterprise-Grade Deployment:** Supports on-premise, VPC, and edge deployments making it suitable for regulated industries and security-sensitive environments.

***

### [Performance Benchmarks](https://blog.codemate.ai/cora-achieves-sota-with-76-resolution-rate-on-swe-bench-verified-subset-outperforming-industry-leaders-2/)

On the SWE-bench verified dataset (a global standard for evaluating software engineering AI), CodeMate's CORA agent leads the field:

| Tool                | SWE-bench Score |
| ------------------- | --------------- |
| **CORA (CodeMate)** | **76%**         |
| GitHub Copilot      | 71%             |
| Cursor (Auto)       | 51%             |

***

### Business Model

CodeMate is available through three licensing models to suit teams of all sizes:

* **Subscription License:** Recurring per-seat access
* **Pay-As-You-Go:** Usage-based billing
* **Perpetual Licenses:** One-time purchase for enterprise deployments

***

### Use Cases

**Enterprise Code Development :** CodeMate enables organizations to maintain enterprise-grade code quality under strict privacy constraints. As a fully self-hosted, SOC 2 and ISO certified solution, it allows teams to leverage powerful AI code reviews without sending sensitive code outside their infrastructure.

**Code Reviews:** CodeMate replaces manual review bottlenecks with continuous, consistent quality checks during development.

**Reducing Delivery Cycles:** By catching errors earlier and automating repetitive tasks, teams ship faster. In production use, delivery cycles have been reduced by up to 83%.

**Developer Onboarding:** New engineers get up to speed faster with context-aware answers about the codebase, reducing the typical 1–2 month ramp-up period significantly.

**Academic & Classroom Use:** Educators integrate AI-assisted tools into coursework and live coding sessions, while students build industry-ready habits from day one even in low-connectivity environments.


# What We Do

### Automating the Entire Software Development Lifecycle

CodeMate is an AI-powered SDLC agent that covers every stage of software development from the first business requirement all the way to production deployment. It works both assistively (alongside developers) and autonomously (executing tasks end-to-end), always within a governance and security guardrail layer.

Everything runs through a single desktop application called **Toolbox**, which orchestrates all products locally on your machine no cloud dependency, no context switching.

***

### The CodeMate Product Suite

#### [Toolbox](/toolbox) (The Central Orchestration Layer)

**What it does:** A desktop application that launches, coordinates, and manages the entire CodeMate product suite from one place.

Toolbox is the foundation everything else is built on. It runs a local subsystem process that bridges your IDE extension with CORA and C0, handles authentication across all products, and provides a fully customizable widget dashboard so you can monitor what matters to you.

Without Toolbox running, the AI features in your IDE are inactive. With it running, every CodeMate product is available, connected, and ready no terminal commands required.

**Available on:** Windows, macOS, Linux download at [app.codemate.ai/download](https://app.codemate.ai/download)

**Includes:**

* Subsystem management (start, stop, auto-start on launch)
* Unified login shared across all products
* IDE extension coordination for VS Code and compatible editors

***

#### [CORA](/cora) (Agentic Architect)

**What it does:** An autonomous coding agent that converts natural language prompts into structured, dependency-aware execution plans and implements them end-to-end.

CORA is CodeMate's most powerful product. Built on the Toolbox subsystem and governed by project-specific Skills, Rules, and Workflows, CORA handles the full development loop from understanding requirements and designing architecture through writing, testing, reviewing, and documenting code. It connects to external tools via MCP servers, making it genuinely capable of acting like a developer rather than just assisting one.

**Agents included:** Code Writing, Documentation, Code Review, Security Testing, QA

**Integrated with:** VS Code, JetBrains IDEs, terminal environments, MCP servers

***

#### [C0](/c0) (AI Coding Assistant)

**What it does:** Deep codebase intelligence for code reviews, debugging, and test case generation, delivered directly inside your IDE.

C0 is orchestrated via the Toolbox subsystem, which enables full codebase indexing, contextual retrieval, and persistent knowledge across your entire repository. Rather than working file-by-file like most AI assistants, C0 understands the structure, history, and relationships across your whole project and surfaces that understanding through a conversational interface in your editor.

**Capabilities include:** code generation, debugging, code review, and documentation synthesis.

**Integrated with:** VS Code, JetBrains IDEs (WebStorm, PyCharm, IntelliJ, and more)

***

#### [Build](/build) (Web App Builder)

**What it does:** Converts Figma designs, prompts, and BRD files into working MVPs, accessible directly from Toolbox.

CodeMate Build bridges the gap between product and engineering. Hand it a Figma file, a product requirements document, or a plain-language prompt, and it generates a functional web application ready for further development all AI-assisted and fully integrated with your CodeMate account.

**Integrated with:** Figma, file uploads

***

#### [PR Review Agent](/pull-request-review-agent) (Automated Pre-Production Checks)

**What it does:** Automated pull request checks and code reviews before code reaches production.

The PR Review Agent acts as a consistent reviewer on every pull request. It checks for code quality issues, security vulnerabilities, test coverage gaps, and adherence to team standards giving developers fast, reliable feedback without waiting for a human reviewer. CodeMate is currently available exclusively as an **Enterprise solution**.

**Integrated with:** GitHub, Bitbucket, GitLab, Azure DevOps

***

#### [CodeMate for Education](/codemate-for-education) (AI Tools for Academic Environments)

**What it does:** Extends the full CodeMate product suite to students, educators, coding clubs, and institutions with offline support and preferential academic pricing.

The gap between academic learning and industry readiness is one of the biggest challenges in computer science education. Students graduate with theoretical knowledge but often lack exposure to modern tooling, workflows, and collaborative development practices. CodeMate for Education bridges this gap by bringing real-world AI development tools into the classroom from day one.

**Available through:** [CodeMate Web App](https://edu.codemate.ai/)

***

### End-to-End SDLC Coverage

Each product maps to a specific phase of the software lifecycle, with Toolbox underpinning all of them:

| Phase                   | CodeMate Product           | What It Does                                       |
| ----------------------- | -------------------------- | -------------------------------------------------- |
| Foundation              | **Toolbox**                | Local subsystem, auth, IDE coordination, dashboard |
| Development             | **CORA**                   | AI-powered autonomous software development         |
| Verification & Quality  | **CORA**                   | Security testing, QA, and quality alignment        |
| Discovery & Research    | **C0**                     | Codebase intelligence and feasibility analysis     |
| Planning & Architecture | **Build**                  | Design-to-prototype, roadmap and infra planning    |
| Deployment & Release    | **PR Review Agent**        | Automated review, deployment, and feedback loops   |
| Education & Onboarding  | **CodeMate for Education** | Academic access, offline learning, educator tools  |

***

### Real-World Impact

When deployed in enterprise environments, CodeMate has delivered measurable results:

* **\~83% reduction** in delivery cycle time
* **\~30% reduction** in development costs
* **42%** of bad code caught before reaching production
* **88%** of developers reported feeling more productive

***

### Global Reach

CodeMate has onboarded **500,000+ users** across **52+ countries** on six continents, with strategic partnerships across hardware, cloud, and enterprise sectors.


# Toolbox

The unified desktop application that orchestrates the entire CodeMate ecosystem from AI coding assistants to your personal developer dashboard.

**Platform:** Windows · macOS · Linux\
**Download:** [app.codemate.ai/download](https://app.codemate.ai/download)

***

### Overview

CodeMate Toolbox is the central orchestration layer for the CodeMate product suite. Rather than managing disparate developer tools across different interfaces, Toolbox brings every CodeMate product under a single desktop application letting you launch services, monitor your environment, manage credentials.

Toolbox is not just a launcher. It runs a local subsystem process that coordinates communication between the products (CORA and C0) and your IDE extension, handles authentication state across all products, and provides a fully customizable widget dashboard for monitoring what matters to you.

***

### Installation

Toolbox is available as a native desktop application for all major operating systems. Download the build that matches your architecture from [app.codemate.ai/download](https://app.codemate.ai/download).

> **macOS note:** On first launch, macOS may show a security prompt. Go to **System Settings → Privacy & Security** and click "Open Anyway" to proceed.

Before Downloading your installer, Please Follow the installation Guide Video present over the  [app.codemate.ai/download](https://app.codemate.ai/download) page.

***

### Integrated Products

#### C0  (AI Coding Assistant)

CodeMate’s AI coding assistant, C0, is an IDE-native system designed to integrate directly into the developer workflow. It is orchestrated via the Toolbox subsystem, which enables full codebase indexing, contextual retrieval, and persistent knowledge. By leveraging this structured understanding of the repository, C0 supports a range of development tasks including code generation, debugging, static analysis, code review, and documentation synthesis. All interactions are exposed through a conversational interface within the IDE, eliminating the need for context switching.

#### CORA (Agentic Architect)

Cora is an IDE-native orchestration layer built on the CodeMate Toolbox subsystem that converts natural language prompts into structured, dependency-aware execution plans and implement them for you. Integrated with external tools via MCP servers and governed by project-specific and global Skills, Rules, and Workflows, Cora enables end-to-end application design, generation, and analysis through a conversational interface, without requiring context switching.

#### Build (Web App Builder)

A visual web application builder accessible directly from Toolbox. Build lets you prototype and ship web apps without leaving the CodeMate ecosystem, AI-assisted and fully integrated with your CodeMate account.

#### Developer Dashboard

Your personalized developer command center. Dashboard surfaces the metrics, tools, and data streams you care about through a widget system. Accessible from Toolbox with your CodeMate account.

***

### Subsystem Management

The subsystem is the process that bridges Toolbox with your IDE extension, coordinating CORA and C0. It must be running for AI assistance in your editor to function. You manage it entirely from within Toolbox no terminal commands required.

#### Starting the subsystem

Open Toolbox and Click **Start** to initialize the local process. Toolbox will show a **online** status indicator once the subsystem is ready to accept IDE connections.

> Recommended: set the subsystem to start automatically on Toolbox launch from **Settings → Subsystem → Auto-start**.

#### IDE extension connection

Once the subsystem is running, your IDE extension (VS Code or compatible editor) automatically connects to it. CORA and C0 become available in the editor sidebar. No additional configuration is needed if you're already logged in to Toolbox.

#### Stopping the subsystem

Click **Stop** in the Subsystem panel. This gracefully terminates all connected AI processes. Your IDE extension will show a disconnected state until the subsystem is restarted.

***

### Dashboard & Widgets

Toolbox includes a built-in customizable dashboard. You choose which widgets appear and what data they surface. The dashboard persists your layout across sessions and is tied to your CodeMate account, so it follows you across devices.

#### Pre-built widgets

| Widget           | Description                                         |
| ---------------- | --------------------------------------------------- |
| Clock            | Displays current time; supports multiple time zones |
| Hacker News      | Live feed of top Hacker News stories                |
| GitHub Activity  | Your GitHub contribution graph and recent events    |
| CPU Activity     | Real-time CPU usage graph                           |
| Memory Usage     | System RAM utilization                              |
| Project Hub      | Quick access to your indexed development projects   |
| System Resources | Combined system health overview                     |
| Time Tracker     | Track time spent on tasks and projects              |

#### Customizing the dashboard

Widgets can be added and removed from the personalize editor. Each widget exposes its own settings panel for configuration for example, the GitHub Activity widget connects to your GitHub account.

***

### Quickstart Guide

Get from download to a working AI-assisted development environment in under five minutes.

**Step 1 - Download and install Toolbox**

Download the installer for your OS and architecture from [app.codemate.ai/download](https://app.codemate.ai/download). Run the installer and launch the application.

**Step 2 - Sign in to your CodeMate account**

Click the login button in the top-right corner of Toolbox. Your session will be shared across all integrated products automatically.

**Step 3 - Start the subsystem**

Go to the **Subsystem** panel and click **Start**. Wait for the status indicator to show a **online** status. This activates C0 and CORA.

**Step 4 - Install the IDE extension**

Install the CodeMate extension from the integrations panel in Toolbox, or from your editor's marketplace (VS Code or compatible editor). Once installed, the extension connects to the running subsystem automatically.

***


# CORA

Cora is CodeMate’s agentic architect mode that turns natural language prompts into complete, production-ready projects through intelligent planning and code generation.

Most AI coding tools help you type faster. Cora does the work that happens before typing and help you type faster: understanding the real requirements behind a prompt, making architectural decisions, planning what depends on what, and then executing the build in the correct order.

Cora runs inside your Code Editor as an extension. It has access to your full codebase, can use external tools via MCP servers, and follows project-specific rules, skills, and workflows you define.

***

### What Cora does

Given a prompt like :

`Build a SaaS analytics dashboard with multi-tenant support and real-time charts` &#x20;

Cora doesn't start writing files. It first maps the problem including requirements nobody mentioned but everyone will eventually need, like an invitation system, API key management for machine-to-machine auth, and tenant-scoped queries on every database call. Then it picks a stack with explicit reasoning. Then it produces a dependency-ordered task graph. Then it builds, layer by layer, validating each layer before the next.

The output is a complete, architecturally sound codebase not a template with placeholders, not disconnected snippets, not a scaffold that still requires days of wiring.

***

### Modes

Cora operates in five modes. Each one is suited to a different kind of task. You select the mode before sending a message, or let Auto choose for you.

| Mode       | What it does                                                                                                           |
| ---------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Auto**   | Orchestrator mode. Cora chooses Plan, Ask, Code, or Review based on what the prompt requires, and can switch mid-task. |
| **Plan**   | Produces architecture documents, stack decisions, and task breakdowns without writing code.                            |
| **Ask**    | Answers questions about your codebase, explains decisions, and gives context without making changes.                   |
| **Code**   | Writes, modifies, and refactors code. The primary execution mode.                                                      |
| **Review** | Audits changes for correctness, consistency, and architectural alignment.                                              |

***

### Configuration

Cora's behavior can be shaped with four types of configuration files you add to your project:

| Type        | Format   | Purpose                                                                                                      |
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| Skills      | Markdown | Domain knowledge Cora can call on API patterns, component conventions, testing approaches                    |
| Rules       | Markdown | Hard constraints that apply to every interaction naming conventions, forbidden patterns, required structures |
| Workflows   | Markdown | Step-by-step processes for recurring tasks feature scaffolding, PR prep, database migrations                 |
| MCP servers | JSON     | External tool integrations GitHub, Slack, databases, APIs, custom internal tools                             |


# Quickstart

Install Cora, open a project, and run your first prompt.

### Install the extension

To use the CORA in your IDE(VS Code, JetBrains, Antigravity, Cursor), ToolBox will act as a centralized hub, to install them and update them whenever required.&#x20;

#### CodeMate Toolbox

Already have Toolbox installed? Install CORA without touching the marketplace.

1. Open **CodeMate Toolbox**.
2. Navigate to **CORA → Install Extension**.
3. Toolbox detects your installed editors and installs the extension automatically.

Don't have Toolbox yet? [Download it here](https://app.codemate.ai/download).

***

### Run your first prompt

1. Open a project folder in your IDE, or start with an empty folder for a new project.
2. Open the Cora panel and select a mode. For a new project, start with **Auto** Cora will plan before it builds.
3. Write a prompt describing what you want to build. Be specific about the domain, key features, and any technical requirements.

```
Build a multi-tenant SaaS analytics dashboard with user auth,
role-based access, a data ingestion API, real-time charts,
and an admin panel for managing organizations.
```

4. Cora will output an architecture plan before writing any files. Review it this is where stack choices and implicit requirements are surfaced. You can push back or ask questions before execution begins.
5. Once you confirm, Cora builds the project layer by layer: foundation, then services, then data layer, then frontend, then integration. Files appear in your workspace as they're generated.

***

### Next steps

After the initial build, continue the conversation to add features, ask questions about the codebase, or run a review pass on recent changes.


# Modes

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

Selecting the right mode matters. Ask mode never modifies files. Review mode never writes new code. Using the wrong mode for a task won't break anything, but it produces worse output than using the right one.

***

### The five modes

| Mode                             | What it does                                                            |
| -------------------------------- | ----------------------------------------------------------------------- |
| [**Auto**](/cora/modes/auto)     | Orchestrates the other modes picks and sequences them based on the task |
| [**Plan**](/cora/modes/plan)     | Produces architecture documents, stack decisions, and task breakdowns   |
| [**Ask**](/cora/modes/ask)       | Answers questions about the codebase and explains how things work       |
| [**Code**](/cora/modes/code)     | Writes, modifies, and refactors code                                    |
| [**Review**](/cora/modes/review) | Audits changes for correctness, security, and consistency               |

***

### Choosing a mode

**Auto** is the right default for most tasks. Use a specific mode when you know exactly what kind of output you want a read-only explanation, a plan with no code yet, or a targeted review of a specific file.

Use **Plan** when you're starting something large and want to review the approach before any files are touched. Use **Ask** when you want to understand something without risking any changes. Use **Code** when you have a clear, scoped task and want direct execution. Use **Review** after any change to a security-sensitive area.


# Auto

Orchestrator mode. Cora selects and sequences the appropriate modes based on what the prompt requires.

Auto is the default mode for open-ended or multi-step tasks. Rather than locking into a single mode, Cora evaluates the prompt and decides whether to plan first, write code, ask a clarifying question, or review what it just produced and can move between modes as the task unfolds.

<figure><img src="/files/lw0Trrzd0m2xDznxGjke" alt=""><figcaption></figcaption></figure>

***

### When to use Auto

Auto is the right choice when you're not sure which mode a task requires, or when a task is likely to span more than one mode. Building a new feature from scratch, for example, naturally involves planning the approach, writing the code, and reviewing the result Auto handles the sequencing without you having to switch manually.

If you have a specific, well-scoped task :

&#x20;`explain this function` ,  `refactor this file`, `review this diff` , `Fix this bug`

using a targeted mode directly is faster and more predictable. Auto adds value when the task is larger or less defined.

***

### How Auto mode works

For a complex prompt, Auto typically follows this order:

1. If the task involves architectural decisions, it runs **Plan** first and surfaces the plan for your review.
2. Once you confirm, it switches to **Code** to execute.
3. After generating changes that touch security-sensitive areas, it runs a **Review** pass automatically.
4. At any point, it can pause in **Ask** mode if it needs clarification to proceed correctly.

The current mode is always visible in the panel. You can see when Cora switches and why.

> You can interrupt Auto at any mode transition. If the plan doesn't look right, push back before execution starts. If the code looks wrong mid-generation, stop and redirect don't let it finish and then ask it to redo.

***

### Auto vs. manual mode selection

Auto does not always sequence all four modes. For a small, unambiguous task like adding a field to an existing model, it will skip Plan and go straight to Code. The planning overhead is proportional to the complexity of the task.

If you want to force a planning step for a task Auto would otherwise execute directly, use Plan mode explicitly, review the output, then switch to Code.


# Marshal

The mode that plans, checks, builds, and verifies so nothing falls through the cracks.

Marshal mode is CORA's structured execution mode. Instead of deciding on the fly what to do next, Marshal mode locks in a fixed sequence of stages **Plan, Reflect, Implement, Review**, and a final **Assessment** and works through them one at a time. It will not skip a stage, rush into code, or silently paper over a problem. Every step is visible, every transition is intentional.

#### When to use Marshal Mode

Marshal mode is built for tasks where doing it wrong is expensive where a missed edge case, an overlooked dependency, or an incorrect assumption could mean hours of rework.

Use Marshal mode when:

* You're making changes that touch multiple files, systems, or features at once
* The task is complex enough that you want a written plan before any code is written
* You've been surprised before by Auto mode making changes you didn't expect or didn't fully review
* You're working on something that matters a critical feature, a migration, a refactor with wide blast radius
* You want full visibility into what CORA is doing and why, at every step

If your task is small or well-scoped `fix this bug`, `refactor this function`, `explain this code` a direct mode like Code or Plan is faster. Marshal mode adds structure that pays off on complex work, not simple tasks.

#### How Marshal Mode works

Marshal mode runs through five stages in order. It will not move to the next stage until the current one is complete.

**1. Plan** CORA reads the codebase, asks questions if needed, and writes a clear implementation plan. Nothing is changed. The goal is to understand the full scope before touching anything.

**2. Reflect** CORA re-reads its own plan and stress-tests it. It looks for gaps, risks, edge cases, and anything that could go wrong. The plan is revised until it's solid.

**3. Implement** CORA executes the plan writing code, making changes, updating files. It follows the plan exactly as written.

**4. Review** CORA checks its own work against the plan. If something doesn't match or a problem is found, it loops back to Implement and fixes it before continuing.

**5. Assessment** A final, thorough review pass. CORA checks for regressions, missed cases, and anything that slipped through. Once this stage passes, the task is complete.

> You can see which stage CORA is in at any point during the task. If you don't like what you see in the Plan or Reflect stage, push back or redirect before CORA starts making changes that's the right time to course-correct.

***

#### Auto Mode vs Marshal Mode

Auto mode is the right default for most tasks. It reads the prompt, figures out the best approach, and sequences things on its own planning when needed, jumping straight to code when not. It's flexible and fast, which is exactly what you want for everyday work.

Marshal mode trades that flexibility for certainty. Every task starts with a written plan. That plan gets stress-tested before a single file is touched. Code only gets written once the plan is locked. Then it's reviewed, fixed if needed, and verified one final time. If you've ever had Auto mode surprise you mid-task with a change you didn't expect, Marshal mode is how you prevent that you see the full picture and sign off before execution begins.

***

#### Running Marshal Mode

Marshal mode works best when you describe the full scope upfront. The more context you give, the stronger the plan.

```
Migrate our authentication system from session-based to JWT. Update all protected routes,
add refresh token support, and make sure nothing breaks in the existing user flow.
```

```
Add a multi-tenant billing system. Each organization should have its own subscription, 
usage tracking, and invoice history. Don't touch the existing single-user billing until 
the new system is verified.
```


# Plan

Produces architecture documents, stack decisions, and dependency-ordered task breakdowns. Does not write any code.

Plan mode is for when you want the thinking without the execution to review, refine, or share a technical approach before committing to an implementation. It's useful at the start of a large feature, when evaluating architectural options, or when you want a structured breakdown of what needs to change before anything is touched.

<figure><img src="/files/EJJKij0c8PhrufYXcJHh" alt=""><figcaption></figcaption></figure>

***

### What Plan produces

A Plan mode output typically includes:

* A summary of explicit requirements what was stated in the prompt
* Implicit requirements things that follow logically but weren't mentioned (the ones that cause problems in week three if they're not accounted for)
* Stack selection with explicit reasoning for each choice
* A breakdown of services and how they interact
* A dependency-ordered task graph, grouped by layer
* Open questions or tradeoffs worth discussing before proceeding

The output is prose and structured lists, not code. It's designed to be reviewed, pushed back on, or shared with a teammate.

***

### Iterating on a plan

Plan output is a starting point. You can respond to any part of it before committing to execution:

```
We're already using MongoDB across the rest of the stack — design
tenant isolation around that instead of PostgreSQL.
```

```
The ingestion API and dashboard can share the same process for now.
We'll split them later if we need to scale.
```

Cora will revise the plan based on your constraints. Once you're satisfied, switch to Code mode or use Auto, which will transition automatically after plan confirmation.

***

### Using Plan on existing codebases

Plan mode is not only for new projects. You can run it against an existing codebase to get a structured description of what's there, identify architectural inconsistencies, or plan a large refactor before touching any files.

```
Review the current authentication system and plan a migration
from session-based to JWT. List every file that will need to change
and flag any breaking changes.
```

***

### Treating the plan as a contract

Once you've confirmed a plan and Code mode begins execution, Cora builds against it. If you want to change the approach mid-execution, say so explicitly and stop the current run rather than letting it continue. Partial execution against a plan you've mentally revised produces inconsistent code that's harder to clean up than starting the phase again.


# Ask

Answers questions about your codebase and explains how things work. Never writes, modifies, or deletes files.

Ask mode has full read access to your project but makes no changes. Use it when you need to understand something before acting how a part of the system works, what a function does, what depends on what, or what would break if you changed something.

<figure><img src="/files/O9iZSG0kuAjU4uzMWm5G" alt=""><figcaption></figcaption></figure>

***

### What Ask is for

Ask is useful any time you need context before making a decision or a change. Some common uses:

**Tracing data flow**

```
Where does the WebSocket event "metric:update" originate?
Trace the full path from ingestion to the frontend chart component.
```

**Understanding dependencies**

```
What would break if I changed the shape of the Event model?
List every file and function that reads from it.
```

**Debugging context**

```
We're getting a 401 on the /events endpoint for a specific API key.
Walk me through how API key validation works what gets checked and in what order.
```

**Understanding existing decisions**

```
Why is the ingestion API a separate Express process instead of
a Next.js API route? What would break if we merged them?
```

***

### Ask vs. Plan

The distinction is backward vs. forward looking. Ask explains what exists in the current codebase. Plan designs what should exist. If you're trying to understand the system as it is, use Ask. If you're trying to figure out how to change it, start with Plan or Auto.

***

### Ask before large changes

A useful habit: run an Ask prompt before any change that touches core infrastructure. Understanding what depends on a thing before you modify it surfaces risks that aren't obvious from reading a single file.

```
Before I refactor the tenant middleware, what are all the places
it's used, and are there any edge cases in how it's currently applied?
```


# Code

Writes, modifies, and refactors code. The primary execution mode.

Code mode makes changes to files. Before writing anything, it reads the existing codebase so that additions and modifications are consistent with what's already there matching the project's folder structure, naming conventions, import patterns, and code style.

<figure><img src="/files/bp0h75sakPwfFc4rqsd6" alt=""><figcaption></figcaption></figure>

***

### Adding new features

When adding a feature to an existing project, Code mode reads the current architecture before writing anything. New files follow the conventions already in use. New endpoints follow the pattern of existing endpoints. New components follow the pattern of existing components.

```
Add a webhook system so organizations can register HTTPS endpoints
to receive alerts when a specific event type exceeds a threshold.
Retry failed deliveries up to 3 times with exponential backoff.
```

Cora will add the `WebhookEndpoint` model to the schema, create the registration API and management UI, extend the aggregation pipeline to check thresholds, build a delivery service with retry logic, and update the admin panel in a style consistent with the surrounding code.

***

### Refactoring

Code mode can refactor across multiple files simultaneously, maintaining consistency across the change.

```
The rate limiter logic is duplicated in three middleware files.
Extract it into a shared utility and update all three to import from there.
```

```
The dashboard API calls are scattered across components. Move them
into a centralized api.ts client with typed return values.
```

***

### Staying in scope

Code mode works best with clear, scoped prompts. The smaller the scope, the more precise the implementation and the easier the diff is to review. For large features, break them into steps model changes first, then service logic, then API layer, then frontend and run Code mode once per step.

> For changes that touch authentication, API key handling, tenant isolation, or database access patterns, follow up with a Review pass after Code completes.


# Review

Audits code changes for correctness, consistency, and architectural alignment. Does not write new code.

Review mode reads code  a recent diff, a specific file, or a set of files you point it at and produces a structured audit. It checks for logical correctness, security issues, consistency with the rest of the codebase, missing edge cases, and alignment with any rules or architectural decisions defined in the project.

<figure><img src="/files/09NgmcmF20btt22LP6jv" alt=""><figcaption></figcaption></figure>

***

### What Review checks

| Category     | Examples                                                                        |
| ------------ | ------------------------------------------------------------------------------- |
| Correctness  | Logic errors, incorrect assumptions about data shapes, off-by-one errors        |
| Security     | Missing auth checks, raw key storage, unsanitized inputs, tenant isolation gaps |
| Consistency  | Patterns that diverge from the rest of the codebase without reason              |
| Edge cases   | Unhandled nulls, missing error states, race conditions                          |
| Architecture | Changes that contradict decisions in the project's rules or plan documents      |

If you have rules files configured in `.cora/rules/`, Review mode enforces them  flagging any code that violates a defined constraint.

***

### Running a review

Point Review at a diff, a file, or describe what just changed:

```
Review the changes I just made to the ingestion pipeline and the
aggregator service. Focus on tenant isolation — make sure orgId
is scoped correctly at every database access point.
```

```
Review the new API key management endpoints for security issues,
particularly around key generation, hashing, and the revocation flow.
```

The output is a list of findings with severity levels, an explanation of each issue, and a suggested fix. You can ask Code mode to apply any of the fixes directly.

***

### When to run Review manually

Run a manual Review pass after:

* Any change to authentication or session handling
* Any change to API key generation, validation, or revocation
* Any change to multi-tenancy logic or tenant-scoped queries
* Any significant schema change
* Any new endpoint that handles user-supplied data

It's faster to catch issues immediately after a change than after several more features have been built on top of it.


# Configuration

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

### Where settings are stored

Cora has two configuration scopes: **global** and **project**.

**Global settings** apply to every project you open. They live in extension storage directory:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/
```

**Project settings** apply only to the current workspace and take precedence over global settings when both exist. They live at the root of your project:

```
your-project/
  .cora/
    skills/
    rules/
    workflows/
    mcp_settings.json
```

Both locations use the same file formats Markdown for skills, rules, workflows, and system instructions; JSON for MCP servers.

***

### Global settings directory

The full structure of the global settings directory:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/
  skills/
    api-conventions.md
    testing-approach.md
  rules/
    security.md
    naming.md
  workflows/
    new-feature.md
    pr-prep.md
  mcp_settings.json
  system-instructions.md
```

Because these are plain files, you can version-control them, sync them across machines with a dotfiles manager, or share a set of skills and rules across a team.

***

### Global vs. project settings

Use **global settings** for conventions and tools that apply to everything you work on a personal coding style, preferred patterns, MCP servers for services you use everywhere like GitHub or Slack.

Use **project settings** for things specific to a codebase its domain vocabulary, its particular API conventions, its security rules, the MCP server for its specific database.

When both scopes define the same type of file (e.g., a `rules/security.md` in both global and project), the project-level file is used for that project. They don't merge line-by-line the project file takes precedence as a whole for that filename.

***

### Configuration types

| Type                | Format   | Purpose                                                           |
| ------------------- | -------- | ----------------------------------------------------------------- |
| Skills              | Markdown | Domain knowledge Cora draws on when relevant to the task          |
| Rules               | Markdown | Hard constraints applied unconditionally to every interaction     |
| Workflows           | Markdown | Step-by-step processes for recurring tasks                        |
| MCP servers         | JSON     | External tool and service integrations                            |
| System instructions | Markdown | Baseline behavior applied at the start of every session           |
| Auto-accept         | Setting  | Whether Cora applies file changes without asking for confirmation |


# Skills

Markdown files that give Cora domain knowledge specific to your project, stack, or technical conventions.

A skill is a structured document that teaches Cora something it should know when working on your codebase. Skills are loaded into context when relevant to the current task, so they influence code generation and planning without you repeating the same information in every prompt.

<figure><img src="/files/Kigo1tmtZkcHoT5xkJF8" alt=""><figcaption></figcaption></figure>

***

### Storage locations

**Global skills** apply to every project:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/skills/
```

**Project skills** apply to the current workspace only:

```
your-project/.cora/skills/
```

Project skills take precedence over global skills when a file with the same name exists in both locations.

***

### What goes in a skill

Skills work best for knowledge that is specific, reusable, and stable the kind of thing you'd put in a team wiki or an onboarding doc every new developer needs to read. Good candidates:

* How your API is structured authentication headers, error response shapes, pagination conventions
* How your components are organized and when to use which one
* How your testing approach works what to test, what to mock, naming conventions for test files
* Domain vocabulary what a "tenant," "workspace," "pipeline," or "event" means in your product
* Third-party integrations with non-obvious behavior an SDK with quirks, a service with particular rate limit semantics

***

### Creating a skill

Create a `.md` file in the skills directory for the appropriate scope. The filename becomes the skill name. Write plain Markdown headers, code blocks, and lists as normal.

Open the file with a single sentence describing what it covers. Cora uses this to decide whether the skill is relevant to the current task.

**Example: `skills/api-conventions.md`**

```markdown
# API conventions

This skill describes the request and response patterns used across
all backend endpoints in this project.

## Authentication

All authenticated endpoints expect a Bearer token in the Authorization
header. The token is a JWT signed with RS256.

Machine-to-machine requests use an API key in the X-Api-Key header —
never a JWT. The two auth flows are separate and must not be conflated.

## Error responses

All errors return JSON in this shape:

{
  "error": "human-readable message",
  "code": "MACHINE_READABLE_CODE",
  "status": 400
}

The `code` field is always SCREAMING_SNAKE_CASE and safe to match on
in client code. The `error` field is for display only.

## Pagination

List endpoints use cursor-based pagination. The response includes
`nextCursor` when more results exist. Pass it as `?cursor=` on the
next request. There is no offset-based pagination in this project.
```

***

### When skills are applied

Cora reads the skill files at the start of each task and loads those relevant to what it's about to do. Writing a new endpoint loads `api-conventions.md`. Writing a component loads `component-patterns.md`. You don't need to reference skills in your prompt Cora matches them to tasks automatically using the opening description of each file.

***

### Editing skills directly

Because skill files are plain Markdown on your filesystem, you can open and edit them in any editor:

```bash
# Edit a global skill
code ~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/skills/api-conventions.md

# Edit a project skill
code .cora/skills/api-conventions.md
```

When a convention in your project changes, update the corresponding skill file. Stale skill files produce output that matches old conventions rather than current ones.


# Rules

Markdown files that define hard constraints Cora applies to every interaction, without exception.

Rules are the invariants of your codebase things that are always true regardless of what the prompt says. Unlike skills, which provide context Cora uses when relevant, rules constrain behavior unconditionally. Cora follows a rule even if a prompt implicitly suggests otherwise.

<figure><img src="/files/5ZlnqXpORT8OKpdsPWfV" alt=""><figcaption></figcaption></figure>

***

### Storage locations

**Global rules** apply to every project:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/rules/
```

**Project rules** apply to the current workspace only:

```
your-project/.cora/rules/
```

Project rules take precedence over global rules when a file with the same name exists in both locations.

***

### What goes in rules

Rules are best suited to constraints where a violation would cause a bug, a security issue, or a consistency problem that would need to be fixed before merging. Good candidates:

* Security invariants: "every database query on tenant-owned data must include an orgId filter"
* Forbidden patterns: things done wrong in the past that must not recur
* Required structures: things every module of a given type must have
* Import constraints: what can import from what, what must not be imported in certain contexts
* Naming conventions that apply everywhere without exception

***

### Creating rules

Create a `.md` file in the rules directory. Write rules as direct, unambiguous statements not explanations, but declarations of what Cora must or must not do.

**Example: `rules/security.md`**

```markdown
# Security rules

Every Prisma query that accesses tenant-owned data must include a
`where: { orgId }` clause. No exceptions, including admin endpoints.

API keys must never be stored in plaintext. Always hash with bcrypt
before writing to the database. Store the first 8 characters in a
separate `prefix` field for UI display.

The ingestion API must never accept JWT authentication.
API key auth via X-Api-Key header only.

Every Express route handler must validate the request body with a
Zod schema before reading any properties from req.body.

Never log full API keys, JWTs, or password hashes. Log the key
prefix or a redacted placeholder instead.
```

**Example: `rules/naming.md`**

```markdown
# Naming conventions

Database models: PascalCase singular — User, Organization, ApiKey.
Service files: camelCase — userService.ts, apiKeyService.ts.
Route files: kebab-case matching the resource — api-keys.ts.
React components: PascalCase. Filename matches the component exactly.
Zod schemas: Schema suffix — CreateUserSchema, UpdateOrgSchema.
Environment variables: SCREAMING_SNAKE_CASE with service prefix —
  DASHBOARD_DATABASE_URL, INGESTION_REDIS_URL.
```

***

### Rules vs. skills

Rules are unconditional. Skills are contextual. If you find yourself writing a skill that says "always do X" it belongs in a rules file instead. A practical test: if Cora violated this during a code generation pass, would you need to fix it before merging? If yes, it's a rule.

***

### Editing rules directly

```bash
# Edit a global rule
code ~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/rules/security.md

# Edit a project rule
code .cora/rules/security.md
```

All rule files in a given scope are loaded together on every task. There's no per-file scoping every rule applies everywhere within its scope.


# Workflows

Markdown files that define step-by-step processes for recurring tasks.

A workflow is a reusable procedure Cora follows when you invoke it by name. Instead of re-explaining a multi-step process every time, you define it once and invoke it with a short prompt. Cora executes each step in order, substituting the specific details from your prompt.

<figure><img src="/files/QdTj453ZOqvwPdBOXys1" alt=""><figcaption></figcaption></figure>

***

### Storage locations

**Global workflows** available in every project:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/workflows/
```

**Project workflows** available in the current workspace only:

```
your-project/.cora/workflows/
```

Global workflows are good for personal processes that apply everywhere  PR prep, commit message generation, changelog updates. Project workflows are good for processes specific to a codebase the exact steps for adding a new feature given this project's structure.

***

### What goes in a workflow

Workflows are most useful for tasks that are multi-step, touch multiple files in a specific order, or need to be done consistently every time. Good candidates:

* Scaffolding a new feature: model, migration, service, route, tests, in the right order
* Preparing a pull request: lint, typecheck, test, write the description
* Adding a new database model: schema, migration, seed, typed repository class
* Creating a new background job: registration, queue config, retry logic, error handling

***

### Creating a workflow

Create a `.md` file in the workflows directory. Write steps as a numbered list with enough detail that Cora can execute each one without ambiguity.

**Example: `workflows/new-feature.md`**

```markdown
# New feature workflow

Run when adding a new backend feature. Replace [feature-name] with
the actual feature in each step.

1. Add the Prisma model to `prisma/schema.prisma`. Follow naming
   conventions in `.cora/rules/naming.md`.

2. Generate and apply the migration:
   `npx prisma migrate dev --name [feature-name]`

3. Update `prisma/seed.ts` if the new model needs local seed data.

4. Create a service at `src/services/[featureName].ts`. Export a
   class with typed methods. Define the interface at the top of
   the file.

5. Create a route at `src/routes/[feature-name].ts`. Validate all
   request bodies with Zod before reading any field from req.body.

6. Register the new route in `src/server.ts`.

7. Write integration tests in `tests/[featureName].test.ts`.
   Cover the happy path and at least two error cases.

8. Update `shared/types/index.ts` with any types shared between
   frontend and backend.
```

**Example: `workflows/pr-prep.md`**

```markdown
# PR preparation workflow

Run before opening a pull request.

1. Run `npm run lint` and fix all errors.
2. Run `npm run typecheck` and fix all type errors.
3. Run `npm test` — all tests must pass.
4. Check for changed files without test coverage and note them
   in the PR description.
5. Write the PR description: what changed, why, any breaking
   changes, how to test locally, and any follow-up work deferred.
6. Scan the diff for accidentally committed debug logging,
   commented-out code, or TODOs that should be filed as issues.
```

***

### Invoking a workflow

Reference the workflow by name in a prompt:

```
Run the new-feature workflow for a webhook subscription system.
```

```
Run pr-prep on the changes from this session.
```

Cora follows the steps in the workflow file, filling in the specific details from your prompt. If a step requires a decision the workflow doesn't cover, Cora asks before proceeding rather than guessing.

***

### Editing workflows directly

```bash
# Edit a global workflow
code ~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/workflows/pr-prep.md

# Edit a project workflow
code .cora/workflows/new-feature.md
```

Workflow steps can reference other config files pointing at `rules/naming.md` or `skills/api-conventions.md` for the specifics. This keeps workflows short and avoids duplicating content.


# MCP servers

Connect external tools and services to Cora using the Model Context Protocol.

MCP (Model Context Protocol) is an open standard for connecting AI agents to external tools. Cora supports MCP servers to give it access to systems beyond the local codebase GitHub, Slack, databases, CI pipelines, internal APIs, and anything else with an MCP server implementation.

<figure><img src="/files/em9oU3c1cnCbmkhPxU1c" alt=""><figcaption></figcaption></figure>

***

### Storage locations

**Global MCP config** available in every project:

```
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/mcp_settings.json
```

**Project MCP config** available in the current workspace only:

```
your-project/.cora/mcp_settings.json
```

Use the global config for services you use across all projects GitHub, Slack, a personal database. Use the project config for services specific to a codebase the project's own database, its staging environment, its internal tools.

***

### Configuration format

`mcp_settings.json` is a JSON file where each key is a server name and the value describes how to start it.

```json
{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "<BASE_PATH>"
      ]
    },
    "git": {
      "command": "uvx",
      "args": ["mcp-server-git"]
    },
    "memory": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-memory"
      ],
      "env": {
        "MEMORY_FILE_PATH": "<BASE_PATH>/memory.jsonl"
      }
    },
    "slack": {
      "command": "npx",
      "args": ["-y", "@jtalk22/slack-mcp"]
    }
  }
}
```

Environment variable references in the format `${VAR_NAME}` are resolved from your shell environment when Cora starts. Never write credential values directly into the file.

> If `mcp_settings.json` is inside a project directory, add it to `.gitignore` — even with environment variable references, the file may reveal internal service names or infrastructure details you don't want in a shared repository.

***

### Using MCP tools in prompts

Once configured, MCP tools are available in any mode. Describe what you want in natural language Cora calls the appropriate tool without special syntax.

```
Check GitHub for open issues tagged "auth" and summarize
what's blocking the multi-tenant login bug.
```

```
Query the production database for the 10 organizations
with the highest event volume in the last 7 days.
```

```
Post a summary of today's merged PRs to the #deployments
Slack channel.
```

```
Create a GitHub issue for the rate limiting edge case we
just found and assign it to the auth milestone.
```

***

### Editing the config directly

Because `mcp_settings.json` is a plain file on your filesystem, you can edit it directly:

```bash
# Edit the global MCP config
code ~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/mcp_settings.json

# Edit a project MCP config
code .cora/mcp_settings.json
```

Changes take effect the next time Cora starts a session. If you add a new server mid-session, reload the Cora panel to pick it up.

***

### Security

MCP servers run as separate processes. Cora calls them over a local interface they don't have access to Cora's context or your environment beyond what you explicitly configure in the `env` block.

Before adding an MCP server from a third party, verify it comes from a trusted source and review what permissions and credentials it requests. A server that only needs to read GitHub issues does not need a token with write access to your repositories.


# Auto-accept

Controls whether Cora applies file changes automatically or waits for your confirmation before writing to disk.

**Cora has two main hands-off modes:**

1. **Auto-accept** (File changes / Write operations)
2. **Auto-approve** (All permission requests / YOLO Mode)

***

#### 1. Auto-accept (File Write Auto-Apply)

**What it does**\
By default, Cora shows you a diff of every proposed file change and asks for confirmation before writing to disk.\
When **Auto-accept is enabled**, Cora applies (writes) the changes to disk immediately after generation, skipping the review step.

**Where to enable it**

* IDE → Cora settings panel (easiest)
* Or manually in settings files:

**Global setting** (all projects):

```bash
~/.config/Code/User/globalStorage/codemateai.codemate-agent/settings/
```

**Project-level setting** (overrides global):

```bash
your-project/.cora/
```

**Recommended use cases (Safe to enable)**

* Working on a dedicated experimental branch
* Small, well-scoped, repetitive tasks you’ve seen Cora do many times
* Fast iteration on a new/throwaway project
* Tests running in watch mode

**Do NOT enable when**

* Changing auth, security, API keys, or multi-tenancy code
* Working on `main` / production branches
* Large refactors or architectural changes
* First time using Cora in a new codebase

**Undo safety**\
Always use Git. Changes are just normal file writes:

```bash
git diff
git checkout -- <file>
git checkout -- .     # discard all
```

> **Rule of thumb**: Never enable Auto-accept without being in a Git repository.

***

#### 2. Auto-approve (Permission / YOLO Mode)

This is more powerful and riskier. It controls whether Cora has to ask you for permission before performing actions.

**Setting name**: "Auto-approve enabled" or "YOLO Mode"

**What it does**\
Runs selected actions without asking for permission. You can enable it per category.

**Available Permission Categories**

| Category                    | What it allows automatically                        |
| --------------------------- | --------------------------------------------------- |
| **Read**                    | Reading files outside the workspace                 |
| **Write**                   | Creating/editing files outside the workspace        |
| **Include protected files** | Editing `.coraignore`, `.cora/` config files etc.   |
| **Execute**                 | Running terminal commands                           |
| **Browser**                 | Browser/MCP operations                              |
| **Subtasks**                | Creating subtasks automatically                     |
| **Delete**                  | File/folder deletion                                |
| **Question**                | Time to wait before auto-selecting the first answer |


# Browser Agent

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.

### Overview

The Browser Tool lets CORA take control of a real browser session. Once enabled, you can tell CORA to open your local frontend, click buttons, fill forms, scroll pages, extract content, and interact with any web interface exactly as a user would, but driven by your instructions.

<figure><img src="/files/vwluQ8q256zucAQMmyM2" alt=""><figcaption></figcaption></figure>

Common use cases:

* **Start your frontend and test it** tell CORA to run `npm run dev`, open `localhost:3000`, and interact with the UI on your behalf.
* **UI automation** navigate flows, trigger states, and verify behavior without writing test scripts.
* **Web scraping** instruct CORA to visit a page and extract structured data.
* **Visual debugging** CORA takes screenshots at each step so you can see exactly what it sees.

***

### Enabling the browser tool

1. Open **CORA** in your editor.
2. Click the **Settings** icon in the CORA panel.
3. Toggle **Enable browser tool** on.

CORA will now have access to a browser session for any task that requires it.

***

### Settings

#### Viewport size

Controls the browser window dimensions CORA uses when taking screenshots and interacting with pages.

| Option        | Dimensions | Best for                     |
| ------------- | ---------- | ---------------------------- |
| Small Desktop | 900 × 600  | Default most desktop layouts |

You can adjust this to match the viewport your app is designed for useful when testing responsive breakpoints.

#### Screenshot quality

Controls the fidelity of screenshots CORA captures at each browser step.

| Setting           | Trade-off                          |
| ----------------- | ---------------------------------- |
| Low               | Fewer tokens, faster responses     |
| **75% (default)** | Balanced clarity and token usage   |
| High              | Maximum clarity, higher token cost |

Increase quality if CORA is misreading fine UI details. Lower it if you're running long browser sessions and want to reduce token consumption.

***

### Remote browser connection (CDP)

By default, CORA launches a local browser session automatically. If you want CORA to connect to an **existing Chrome instance** instead for example, a browser already authenticated to a service, or a remote browser in a CI environment you can connect over the **Chrome DevTools Protocol (CDP)**.

#### Enable remote connection

1. In CORA Settings, toggle **Use remote browser connection** on.
2. Enter your CDP host in the field provided.
3. Click **Test Connection**. CORA will attempt to connect and confirm the session is reachable.

If you leave the field empty, CORA will auto-discover any Chrome instances running locally with remote debugging enabled.

### Example workflows

#### Start and test a local frontend

```
Start the dev server with `npm run dev`, then open localhost:3000,
click the Login button, and tell me if the form renders correctly.
```

CORA will run the dev server, open the browser, navigate to the page, interact with it, and report back with screenshots at each step.

#### Scrape a page

```
Go to https://example.com/pricing and extract all plan names and prices
into a JSON array.
```

#### Automate a UI flow

```
Open localhost:3000, sign in with test@example.com / password123,
navigate to the dashboard, and click "Create new project".
```


# C0

C0 is an AI-powered coding assistant built into your IDE. It indexes your entire codebase, remembers what it learns, and helps you write, debug, review, document, and understand code all through natural conversation, without ever leaving your editor.

***

### What makes C0 different

Most AI coding tools work in isolation. They don't know your project, your patterns, or your team's conventions. Every session starts from scratch.

C0 is built around a **persistent knowledge base** that continuously indexes your codebase. It understands your functions, your dependencies, your architectural patterns, and how everything connects. That understanding carries across sessions, so C0 gets more useful the longer you use it not less.

On top of that foundation, C0 offers a set of purpose-built **workflows** not a generic chat box, but specific modes designed around the things developers actually do all day: debugging, writing tests, reviewing code, documenting code and working from Jira tickets.

***

### Core workflows

| Workflow            | What it does                                                   |
| ------------------- | -------------------------------------------------------------- |
| Chat with code      | Ask questions about your codebase in plain language            |
| Debug mode          | Trace errors to their root cause and fix them                  |
| Optimize mode       | Improve performance, readability, and structure                |
| Generate test cases | Write meaningful tests for any function or module              |
| Code reviews        | Catch bugs and issues before code is merged                    |
| Deep Wiki           | Generate rich documentation with usage notes and edge cases    |
| Code Map            | Visualize code structure and system flow with Mermaid diagrams |
| Swagger Agent       | Agent works with Swagger documentation and API Specifications  |

***

### Integrations

| Integration    | What it does                                         |
| -------------- | ---------------------------------------------------- |
| Jira           | Work directly from tickets without context-switching |
| Knowledge base | The persistent memory layer that powers everything   |

***

## Get Started with C0

> New to C0? Install the extension, connect your codebase, and run your first workflow in under five minutes.

***

### Choose your environment

#### VS Code / Cursor / Antigravity

Install the C0 extension directly from the Extension panel in the IDE. Before Installing download and Setup the CodeMate ToolBox in your device, this is crucial as all the CodeMate Products communicate with each other through the ToolBox.&#x20;

#### CodeMate Toolbox

Already have Toolbox installed? You can install the C0 extension directly from within it no marketplace required.

1. Open **CodeMate Toolbox**.
2. Navigate to **C0 → Install Extension**.
3. Toolbox will detect your installed editors and install the extension automatically.

Don't have Toolbox yet? [Download it here](https://app.codemate.ai/download).


# Quickstart

Get C0 installed, connected to your codebase, and running your first workflow in under five minutes.

### 1. Install C0

Open the Extensions view (`Cmd+Shift+X` on Mac, `Ctrl+Shift+X` on Windows/Linux) and search for   **C0**.

***

### 2. Sign in

On first launch, C0 will prompt you to sign in. Click **Sign in with C0** and complete authentication in your browser. Once signed in, you'll be returned to your IDE automatically.

***

### 3. Open a project and let C0 index it

Open any project folder in your IDE. C0 will detect it and begin indexing your codebase automatically.

You'll see a status indicator in the C0 panel:

* **Indexing:** C0 is reading your files and building its knowledge base
* **Ready:** indexing is complete; C0 now understands your codebase

For small projects, indexing takes under a minute. For larger codebases, it may take a few minutes on the first run. After that, C0 only re-indexes files that have changed, so subsequent updates are nearly instant.

> **Note:** You can start using C0 before indexing finishes. Results will improve as indexing progresses.

***

### 4. Try your first workflow

Once indexing completes, try one of these to see C0 in action:

**Ask a question about your code:**

Open the C0 chat panel and type:

```
@<Select your Knowledgebase> How does authentication work in this project?
```

C0 will read the relevant files, trace the flow, and give you a clear explanation grounded in your actual codebase not a generic answer.

**Debug an error:**

Switch to **Debug mode** in the C0 panel, paste an error message or stack trace, and hit enter:

```
TypeError: Cannot read properties of undefined (reading 'userId')
  at AuthMiddleware.verify (src/middleware/auth.js:34)
```

C0 will locate the source of the problem, explain why it's happening, and offer a fix.

**Generate tests for a file:**

Switch to **Generate tests** mode, select a file or function, and run it. C0 will produce a full test suite matched to your project's existing test framework and conventions.


# Chat

Unlike a generic AI assistant, C0 chat answers questions with reference to your actual code. It reads your files, follows call chains, and gives you answers grounded in what's really there not what typically exists in a project like yours.

***

### Opening chat

Select **Chat** from the mode selector in the C0 panel.

***

### Asking questions

Type any question in plain language and press Enter. C0 reads the relevant parts of your codebase and responds with a specific, grounded answer.

**Understanding an area of code you've never touched:**

```
How does the notification system work?
What triggers a notification and how does it get delivered?
```

**Tracing data through a system:**

```
Where does a user's profile picture get stored after upload? 
Trace it from the API endpoint to the final storage location.
```

**Understanding behavior before making a change:**

```
If I change the return type of getUserById from User to User | null,
what else in the codebase will I need to update?
```

**Finding where something is implemented:**

```
Where is the retry logic for failed API calls? Is it centralized or scattered across services?
```

***

### Using @mentions to set scope

By default, C0 searches across your entire indexed codebase to answer a question. If you want to focus on a specific file, function, or directory, use @mentions.

```
@src/services/billing.ts How does proration work when a user upgrades mid-cycle?
```

```
@PaymentService.charge Walk me through exactly what happens when a charge fails.
```

```
@src/api/routes/ Which endpoints are missing authentication middleware?
```

@mentions can reference:

* File paths — `@src/utils/logger.ts`
* Directories — `@src/services/`
* Function or class names — `@UserRepository.findById`

You can combine multiple @mentions to give C0 a richer scope:

```
@AuthService @TokenValidator How do these two work together to validate a request?
```

***

### Referencing selected code

Select any code in your editor before asking a question and C0 will use your selection as the primary context.

This is useful when you want to ask something about a specific block without typing out a file path:

1. Select the code
2. Open the C0 chat panel
3. Ask your question C0 will automatically attach the selection

```
(with a complex function selected)
"What does this do? Are there any edge cases I should know about?"
```

***

### Following up

Chat is conversational. C0 remembers what was said earlier in the session, so you can ask follow-up questions without repeating context.

```
You: How does session expiry work?
C0:  (explains the session expiry flow, referencing SessionManager and the Redis TTL logic)

You: What happens if the Redis connection is down when a session expires?
C0:  (continues from the previous answer, now tracing the error path)

You: Is that error handled the same way everywhere, or are there inconsistencies?
C0:  (searches the codebase for all session error handlers and compares them)
```

***

### What chat is good for

Chat works best for **understanding** exploring, learning, and reasoning about code before making changes.

| Good for chat                        | Better with another workflow              |
| ------------------------------------ | ----------------------------------------- |
| "How does X work?"                   | Fixing a specific bug → Debug mode        |
| "Where is Y implemented?"            | Improving a slow function → Optimize mode |
| "What calls Z?"                      | Writing tests → Test generation           |
| "What will break if I change W?"     | Reviewing a PR → Code review              |
| "Explain this code to me"            | Documenting a module → DeepWiki           |
| "How does this system fit together?" | Visualizing a system → CodeMaps           |

***

### Tips

**Be specific about what you want to understand.** `How does auth work?` gets a general answer. "How does token refresh work when a user's access token expires mid-session?" gets a precise one.

**Ask about behavior, not just structure.** C0 can explain not just what code does, but what happens in specific scenarios timeouts, edge cases, error paths, concurrent access.

**Use chat to plan before you change.** Before refactoring or adding a feature, ask C0 to map out what's involved. This surfaces dependencies and risks before you touch anything.


# Knowledge Base

This page explains how the knowledge base works, how to extend it with your own knowledge, and how to keep it healthy over time.

### Streamline your development workflow with CodeMate's Knowledge Base

Consolidate your coding resources within a single, organized platform. Import private or public GitHub repositories, integrate relevant webpages, and upload custom codebases all seamlessly accessible within the Knowledge Base. This centralized hub empowers efficient code exploration, fosters context-aware insights from C0 and ultimately accelerates your development process. Enhance your coding experience with a unified resource repository.

<figure><img src="/files/npJw3yM28wHwxZpclxT7" alt="" width="244"><figcaption></figcaption></figure>

<figure><img src="/files/b1sGeqeIk77qMt3dvgjX" alt=""><figcaption></figcaption></figure>

1. **Knowledge Base supports addition of these file types:**

* **Import private or public GitHub repositories:** Connect your GitHub account and seamlessly integrate your codebases within Knowledge Base.
* **Import web URL:** Add relevant webpages for deeper analysis, specifying the desired depth of exploration for each URL.
* **Add codebases:** Upload your own custom code resources directly into the Knowledge Base for convenient reference.

2. **Organization and access:**

* **View Knowledge base:** Easily access and manage all added resources through a dedicated "View Knowledge Base" section.
* **Centralized context:** All imported files contribute to your organization's overall context, enabling C0 to provide more relevant and accurate responses.

Read more about how to add & manage content under Knowledge Base in [Feature Walkthrough ](/feature-walkthrough#codemate-vs-code-extension)docs.

**Feature availability**: Knowledge Base can be accessed from C0 VS Code Extension and CodeMate CLI.&#x20;


# Debug Code Agent

Debug your code with the help of our debug agent.

The Debug Code feature analyzes your code on multiple test cases based on your approach and generates detailed fixes along with a description of the error that you may have otherwise missed to achieve the desired output.

Powered by internal AI agents, CodeMate's debug feature is a powerful tool that can help developers identify and fix errors in their code. It uses a combination of static analysis and machine learning to detect a wide range of errors, including:

* **Syntax errors**: Errors in the structure of the code, such as typos, missing commas, or mismatched parentheses.
* **Logical errors**: Errors in the logic of the code, such as incorrect conditional statements or loops.
* **Runtime errors**: Errors that occur when the code is executed, such as null pointer exceptions or out-of-bounds array accesses.
* **Compile-time errors**: Errors that are detected by the compiler, such as using an undeclared function or violating a type constraint.

<figure><img src="/files/zDVexQ7GJj014AdaRt6M" alt=""><figcaption></figcaption></figure>

In addition to detecting errors, CodeMate's code debug feature can also help developers to understand their code better.

It can provide explanations of how the code is executed, and it can show the values of variables at different points in the execution flow. This can be helpful for understanding complex algorithms and for tracking down the source of errors.

Once an error has been identified, CodeMate provides a detailed explanation of the error and suggests possible solutions. It can also automatically fix identified errors in a single click.

**Feature availability**: The Debug Code feature can be accessed within VS Code Extension, CodeMate CLI and CodeMate Web App.&#x20;


# Code Review Agent

Review your code with the help of our review agent.

#### Get detailed code reviews

Get detailed code reviews\
Review your code as per best practices to be followed in software development through AI as if an experienced developer is sitting beside you.

C0 code review feature is a valuable tool for helping developers improve the quality of their code. Internally powered by specialized AI agents, it can identify potential problems in your code, such as:

* **Code smells**: Indicators of bad coding practices, such as long methods, complex conditionals, or excessive duplication.
* **Security vulnerabilities**: Code that could be exploited by attackers, such as SQL injection or cross-site scripting vulnerabilities.
* **Performance issues**: Inefficient code that could be optimized to run faster.

<figure><img src="/files/qY27bmRyYmM14JAE5P17" alt=""><figcaption></figcaption></figure>

**Custom Code Reviews**

C0 can also be customized to review code against specific coding standards and best practices. This ensures that all code remains consistent and meets your team’s expectations. You can add your own metrics in natural language or include a bug report to get tailored, AI-driven code reviews.

In addition to providing intelligent suggestions for improvement, C0 review agents can generate detailed reports summarizing the review findings. These reports help track progress and highlight areas where improvements are needed.

C0 review agents are equally effective for reviewing your own code or evaluating code written by others, ensuring a consistent standard of quality across your entire team.

**Feature availability**: The Review Code feature can be accessed from the **C0 VS Code Extension**, **CodeMate CLI**, and **CodeMate Web App**.


# Optimize Code Agent

Optimize your code with the help of our optimize agent.

Now refactor your entire code within seconds to make it much more efficient and modular. C0 is your all-in-one tool functioning as a code assistant, performance optimizer, and efficiency booster. This documentation specifically highlights the Optimization feature, streamlining code effortlessly through intelligent AI agents working in the background.

### Key Features

**1. Code Analysis**

Internally powered by AI agents, C0 deeply analyzes your code, identifying areas for enhancement such as nested loops, inefficient algorithms, or memory leaks.

**2. Flexible Refactoring**

AI-powered agents offer flexible refactoring options, allowing you to choose approaches that align with your code's requirements and personal coding style.

**3. Immediate Implementation and Learning**

With a single click, C0 AI agents apply selected optimizations and explain each step - contributing to your coding proficiency while making your code better instantly.

<figure><img src="/files/qWAqmB2tZcRqdBpHco9A" alt=""><figcaption></figcaption></figure>

### Comprehensive Optimization

C0 Optimization agents don’t just aim for faster code-they enhance **memory efficiency**, **maintainability**, and **security** as well.

* **Memory Efficiency**: Reduce code footprint for smoother operation on resource-constrained devices.
* **Maintainability**: Improve readability, making debugging and updates simpler for long-term scalability.
* **Security**: Strengthen code structure to eliminate common vulnerabilities and exploitable patterns.

### Advantages

**1. Tailored Solutions**

C0 AI agents adapt to your coding style and the language you’re working in, offering optimization suggestions specific to your project.

**2. Human-in-the-Loop**

Retain full control C0 empowers you to choose the best optimization path based on agent suggestions.

**3. Continuous Learning**

With each update, C0 AI agents evolve by learning from new code patterns and best practices.

C0 optimization feature isn’t just a tool it’s a philosophy. It’s about writing cleaner, faster, and more sustainable code. It’s about pushing the boundaries of what your code can achieve. Let C0 internal AI agents be your secret weapon to code like a pro.

**Feature availability**: This feature is available across the **C0 VS Code Extension** & **CodeMate CLI**.


# Test Cases Agent

Generate high quality test cases efficiently for your codebase.

Orchestrate generation of test cases easily with C0. Internally powered by AI agents, C0 intelligently analyzes your code snippet and generates precise test cases that cover a wide range of targeted scenarios.

Use this feature to generate test cases with both efficiency and accuracy. With AI agents handling the heavy lifting, teams become more productive and agile by automating one of the most critical stages of the software development lifecycle. Developers can initiate test case generation with just a click freeing up time for more complex engineering tasks.

<figure><img src="/files/XEqV5e0OjSC6FwtITIkp" alt=""><figcaption></figcaption></figure>

**Advantages:**

* **Time-Saving**\
  By automating test case generation through AI agents, C0 significantly reduces the time developers spend writing tests - enabling more time for innovation.
* **Consistency**\
  AI agents ensure a uniform approach to test case creation, minimizing human error and improving reliability across test suites.
* **Comprehensive Coverage**\
  Generated test cases span a wide array of scenarios, helping ensure robust coverage and minimizing blind spots in testing.
* **Ease of Use**\
  With a simple, intuitive interface, generating test cases becomes as easy as clicking a button accessible to developers at all experience levels.
* **Scalability**\
  Whether you're testing a small module or a large-scale application, C0 AI-driven test case generation scales effortlessly to meet your needs.

**Feature Availability**: This feature is available in the **C0 VS Code Extension**.


# Swagger Agent

The **Swagger Agent** in C0 enables fast, AI-powered backend code generation directly from your Swagger API definitions. Instead of spending hours manually writing boilerplate code for your APIs, Swagger Agent automates the process while allowing complete control and customization through AI instructions.

### What It Does

Swagger Agent automates the conversion of API definitions into real, deployable code structures using advanced AI models. By analyzing OpenAPI documents (via file upload or URL), it intelligently generates code that adheres to software development best practices reducing setup time from hours to minutes.

<figure><img src="/files/3unlneSgBYhYL0lhE4vW" alt=""><figcaption></figcaption></figure>

### How It Works

From the intuitive UI in the **C0 Dashboard**, developers can:

* **Choose a Source Type**: Upload a local OpenAPI file or input a public URL.
* **Select Client Language**: Pick the target language for your API (e.g., Python, Node.js, etc.).
* **Specify Base URL**: Define your API’s base address (if applicable).
* **Add Custom Instructions**: Provide any additional logic, preferences, or specific implementation details.

Once configured, clicking **"Create"** initiates the AI-driven generation process. The result is a ready-to-use backend skeleton reflecting the Swagger schema, with routes, data models, and request handlers auto-generated.

> Example Use Case:\
> Upload a Swagger file describing a product catalog API, choose Python as the client language, and include custom instructions such as “use Flask with JWT authentication.” Swagger Agent will respond with a structured codebase reflecting those needs.

### Core Features

* **Language Support**: Generate code in Python, JavaScript, and more (with expanding language options).
* **Smart Schema Mapping**: Detects data types, request patterns, and endpoint hierarchies from the schema.
* **Optional Instructions**: Refine and guide the generation with natural language prompts.
* **Integration Ready**: Easily push the generated project into C0 Build environment for further modification or deployment.

### Benefits

| Feature             | Description                                                                                  |
| ------------------- | -------------------------------------------------------------------------------------------- |
| **Speed**           | Turn API documentation into real code in minutes.                                            |
| **Accuracy**        | Eliminates human error in manual scaffolding or misinterpretation of specs.                  |
| **Scalability**     | Handle complex multi-endpoint APIs with consistent structure and modular output.             |
| **Customizability** | Influence the final code with optional AI instructions tailored to your stack and standards. |

### Accessing Swagger Agent

You can use this feature directly from [C0 Extension](https://marketplace.visualstudio.com/items?itemName=AyushSinghal.Code-Mate\&ssr=false#review-details)


# Deep Wiki

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

### Opening Deep Wiki

You can hover over a function/class → get an option **Open in Deep Wiki** and It generates very rich, structured documentation with proper sections.

<figure><img src="/files/deQmZqcfgEogZy0YRKtU" alt=""><figcaption></figcaption></figure>

***

### What Deep Wiki generates

For each target, C0 produces a structured documentation entry with the following sections:

#### Overview

A plain-language description of what the code does its purpose and responsibility, written for a developer who hasn't read the implementation.

#### Signature

The function or class signature, including parameter types, return type, and thrown exceptions.

#### When to use it

This is what separates Deep Wiki from a docstring generator. C0 reads how the code is actually used across your codebase and writes guidance for when it's the right tool and when it isn't.

```
Use OrderService.create() when creating an order from a user-facing flow (checkout,
subscription renewal, admin order entry). Don't use it for programmatic test data
setup use OrderFactory from tests/support/factories.ts instead, which skips
payment processing and email sending.
```

#### Parameters

Each parameter documented with its type, purpose, acceptable values, and what happens with edge cases (null, empty, zero, maximum values).

#### Return value

What the function returns, what the shape of the data looks like, and what to check for before using it.

#### Throws / error cases

Every exception or error condition the function can produce, what triggers it, and how callers should handle it.

#### Best-case usage notes

Practical guidance on how to use the code well the patterns that work, the ones that don't, and the things experienced developers know that aren't obvious from the signature alone.

```
Best results: call recalculateTotals() after any mutation to the order's line items.
If you're making multiple mutations, batch them and call recalculateTotals() once at
the end — it's expensive and doesn't need to run after each change.
```

#### Known edge cases

Specific inputs or conditions that produce behavior worth knowing about things that aren't bugs but aren't immediately obvious.

```
Edge cases:
- If quantity is 0, the item is removed from the order rather than kept with a zero quantity.
- If all items are removed, the order is cancelled automatically, not left as an empty order.
- Applying a discount code that's already applied is a no-op, not an error.
```

#### Related functions

Functions and classes that work closely with this one either called by it, calling it, or used alongside it.

***

### Examples

**A service method:**

```
Input: @SessionManager.refresh  "Generate a Deep Wiki entry."

Output:

## SessionManager.refresh(sessionId: string, userId: number): Promise<Session>

### Overview
Refreshes an existing session, extending its TTL and returning the updated Session
object. Called automatically by the auth middleware on authenticated requests.

### When to use it
Use this when you need to explicitly extend a session outside of a normal request
cycle — for example, during a long-running background job initiated by a user action.
Don't call this directly in request handlers; the middleware handles it automatically
for all authenticated routes.

### Parameters
- sessionId — the session token string from the user's cookie or Authorization header.
  Must be a valid session that exists in Redis. Throws SessionNotFoundError if absent.
- userId — the ID of the user the session belongs to. Used to verify the session
  belongs to the correct user before refreshing. Throws SessionMismatchError if it
  doesn't match.

### Returns
The updated Session object with the new expiresAt timestamp.

### Throws
- SessionNotFoundError — the sessionId doesn't exist in Redis (expired or never existed)
- SessionMismatchError — the session exists but belongs to a different userId
- StorageError — Redis is unavailable

### Best-case usage notes
The TTL on refresh is controlled by SESSION_TTL_SECONDS in config/auth.ts.
If you need to refresh with a non-standard TTL (e.g., "remember me" sessions),
use SessionManager.refreshWithTTL() instead.

### Known edge cases
- Calling refresh on a session that expires within the next 5 seconds may result in
  a SessionNotFoundError, because Redis may have already evicted it by the time the
  write completes.
- If Redis is in readonly mode during a failover, refresh will throw StorageError
  but the auth middleware will still allow the request to proceed (fail-open behavior).

### Related
- SessionManager.create() — creates a new session
- SessionManager.invalidate() — terminates a session
- AuthMiddleware.verify() — the main caller in request flows
```

***

### Generating wiki entries for modules

Deep Wiki works at the module level too, not just individual functions. Point it at a directory or a group of related files and it generates an overview document for the whole module:

```
@src/services/  "Generate a Deep Wiki overview of the services layer."
```

The module-level entry covers: what the module is responsible for, what it isn't responsible for, how it's organized, what external dependencies it takes on, and how to navigate it.

***

### Keeping documentation current

Deep Wiki entries are stored in your project (by default in a `docs/wiki/` directory, configurable in settings). As your codebase changes, C0 detects when an indexed function has changed significantly and flags the corresponding wiki entry as potentially stale.

You can re-generate a wiki entry at any time, or configure C0 to automatically update wiki entries when the underlying code changes.

***

### Tips

**Generate wiki entries for the hardest parts of your codebase first.** Every team has functions that every engineer has to re-read every time they touch them. Generate Deep Wiki entries for those immediately the ROI is highest where understanding is most expensive.

**Use Deep Wiki during onboarding.** When a new team member joins, point them at the Deep Wiki entries for the core services and workflows. A good set of entries turns a month of context-building into a week.

**Include "when NOT to use" guidance.** The most valuable documentation often explains what not to do. When C0 generates a wiki entry, read the "when to use it" section and add notes for the anti-patterns you've seen calls you've had to revert, mistakes that come up in code review. C0 generates from the code; you add from experience.

**Use it after debugging.** When you've just finished debugging a gnarly issue in a function, generate a Deep Wiki entry immediately. You understand that code better in that moment than you will for a while. That understanding ends up in the entry.


# Code Maps

Code Map generates diagrams of your code visually rendered, always accurate, produced from your actual codebase. Use it to understand system structure, trace data flow, map dependencies, or explain architecture to a teammate. Diagrams are rendered using Mermaid directly in your IDE.

***

### Opening Code Map

Open it by selecting Code Map section in the C0 panel

<figure><img src="/files/Z73wnKoSUaZPpmDetMUa" alt=""><figcaption></figcaption></figure>

***

### What you can map

#### Request and data flow

Trace how a request moves through your system from entry point to response, including every service, function, and data transformation along the way.

```
Show me how a checkout request flows through the system, 
from the API endpoint to the order being created in the database.
```

```
Map the data flow for user authentication 
from the login form submit to the session being set.
```

#### Module and dependency structure

Visualize how your modules depend on each other. Identify circular dependencies, overly coupled modules, and the natural seams in your system.

```
Map the dependencies between the services layer. Show which services depend on which.
```

```
Show the dependency graph for the checkout module. 
I want to understand what it touches before I refactor it.
```

#### Class and inheritance hierarchies

Visualize class relationships inheritance, composition, and interface implementation.

```
Map the class hierarchy for the payment providers.
Show how the base class and each provider implementation relate.
```

#### State machines and lifecycle flows

Diagram how an entity moves through states over its lifetime.

```
Map the lifecycle of an order every state it can be in and the transitions between them.
```

```
Show the states a subscription can be in and what events cause transitions.
```

#### System architecture

Get a high-level architectural view of a system or feature area.

```
Give me an architectural diagram of the notification system all the components involved and how they connect.
```

***

### How Code Map works

C0 reads your codebase using the knowledge base call graphs, import chains, class relationships, and function interactions and generates a Mermaid diagram that accurately represents the structure or flow you asked for.

The diagram is grounded in your actual code, not a generic template. Function names, class names, module names, and flow paths come from what's really there.

***

### Diagram types

C0 selects the most appropriate Mermaid diagram type based on your request:

| What you're mapping                         | Diagram type                         |
| ------------------------------------------- | ------------------------------------ |
| Request or data flow                        | Flowchart (`graph LR` or `graph TD`) |
| Sequence of interactions between components | Sequence diagram                     |
| Module or file dependencies                 | Graph or flowchart                   |
| Class hierarchy or relationships            | Class diagram                        |
| State transitions                           | State diagram                        |
| Process or lifecycle                        | Flowchart or sequence diagram        |

You can also request a specific diagram type:

```
Show the authentication flow as a sequence diagram.
```

***

### Example outputs

**Request flow — checkout endpoint:**

```mermaid
graph TD
    A[POST /api/orders] --> B[AuthMiddleware.verify]
    B --> C[OrderController.checkout]
    C --> D[CartService.getCart]
    C --> E[PaymentService.charge]
    E --> F[Stripe API]
    F -->|success| G[OrderService.create]
    F -->|failure| H[PaymentFailedError]
    G --> I[InventoryService.reserve]
    G --> J[NotificationService.send]
    G --> K[OrderRepository.save]
    K --> L[(Database)]
    J --> M[EmailService.send]
    J --> N[PushService.send]
```

**State machine — order lifecycle:**

```mermaid
stateDiagram-v2
    [*] --> Draft
    Draft --> PendingPayment : user submits checkout
    PendingPayment --> PaymentFailed : payment declined
    PaymentFailed --> PendingPayment : user retries
    PendingPayment --> Confirmed : payment succeeds
    Confirmed --> Processing : warehouse picks up
    Processing --> Shipped : tracking number assigned
    Shipped --> Delivered : delivery confirmed
    Delivered --> [*]
    Confirmed --> Cancelled : user cancels
    Processing --> Cancelled : admin cancels
    Cancelled --> [*]
```

**Sequence diagram  auth flow:**

```mermaid
sequenceDiagram
    participant Client
    participant AuthController
    participant AuthService
    participant TokenValidator
    participant SessionManager
    participant Redis

    Client->>AuthController: POST /auth/login
    AuthController->>AuthService: authenticate(email, password)
    AuthService->>AuthService: bcrypt.compare(password, hash)
    AuthService->>TokenValidator: generateAccessToken(userId)
    TokenValidator-->>AuthService: accessToken
    AuthService->>SessionManager: create(userId, accessToken)
    SessionManager->>Redis: SET session:{token} userId TTL 7d
    Redis-->>SessionManager: OK
    SessionManager-->>AuthService: session
    AuthService-->>AuthController: { user, accessToken }
    AuthController-->>Client: 200 { user, token }
```

***

### Saving diagrams to your documentation

Exported Mermaid source renders natively in GitHub, GitLab, Notion, Confluence, and most modern documentation tools. Copy the diagram source from C0 and paste it directly into your docs. You can export as Mermaid source code or an SVG.

### Tips

**Use Code Map before refactoring.** Before restructuring a module or splitting a service, map its dependencies. You'll see every connection that needs to be preserved, moved, or cut before you've changed anything.

**Use Code Map when onboarding to unfamiliar code.** A five-minute diagram of a system's request flow tells you more than twenty minutes of reading files. Start with the map, then drill into the files you care about.

**Follow up with Chat.** Code Map and Chat work well together. Generate a diagram to understand the structure, then switch to Chat to ask questions about the specific parts you don't understand.

**Map state machines for product clarity.** State diagrams are useful beyond engineering. An order lifecycle diagram or a subscription state machine is something a product manager, a support team, or a designer can read and validate. Generate it in C0 and drop it into your team's documentation.


# Jira Integration

C0's Jira integration connects your tickets to your editor.

Pull a ticket into context and work on it directly no copy-pasting requirements between tabs, no switching context. C0 reads the ticket, understands what's needed, and helps you implement it.

***

### Connecting Jira

Open C0 navigate to **Jira Integration**, and click **Connect**.

You'll be prompted to authorize C0 with your Atlassian account. Once authorized, select the Jira projects you want c0 to have access to.

***

### Working from a ticket

#### Pull a ticket into context

In any C0 workflow, reference a ticket by its ID:

```
@PROJ-1042 Implement the changes described in this ticket.
```

C0 reads the full ticket title, description, acceptance criteria, comments, attached designs or specs and uses that as the brief for the work.

#### Let c0 interpret the requirements

C0 translates the ticket into a concrete implementation plan:

```
@PROJ-1042 What code changes are needed to implement this?
Walk me through your plan before making any changes.
```

C0 reads the ticket and the relevant codebase, then outlines: which files need to change, what the implementation approach should be, any risks or ambiguities in the requirements, and what tests should be written. You review the plan before C0 does anything.

#### Implement directly

Once you're aligned on the approach, tell C0 to proceed:

```
@PROJ-1042 Implement this. Start with the service layer 
and I'll review before you touch the API routes.
```

C0 makes the changes, explains what it did, and waits for your review at any checkpoints you've specified.

***

### Ticket-aware workflows

#### Debug with ticket context

When debugging a bug ticket, include the ticket for context:

```
@BUG-829 Debug this. The ticket has the reproduction steps and the error logs.
```

C0 reads the reproduction steps and logs from the ticket rather than requiring you to re-type them.

#### Review against acceptance criteria

When reviewing code for a ticket, C0 can check the implementation against the ticket's acceptance criteria:

```
@PROJ-1042 Review my changes against the acceptance criteria in this ticket.
```

C0 reads the criteria from the ticket and flags any gaps in the implementation.

#### Generate tests from a ticket

```
@PROJ-1042 Generate tests that cover the acceptance criteria in this ticket.
```

C0 reads the acceptance criteria and writes tests that verify each one not just generic tests for the code.

***

### Creating and updating tickets from C0

#### Log findings during debugging

If you discover something during a debug or review session that warrants a new ticket a related bug, a missing feature, a tech debt item you can create a Jira ticket without leaving C0:

```
Create a ticket for the N+1 query issue we found in OrderService. 
Label it as a bug, high priority.
```

C0 creates the ticket with a structured description of the issue, including the file name, line number, and explanation it already has from the debug session.

***

### Searching tickets

```
Show me the open tickets assigned to me in the PROJ project.
```

```
Find the ticket for the payment retry logic I think it was filed last month.
```

C0 searches your connected Jira projects and returns matching tickets. You can then pull any of them into context by referencing their ID.

***

### Tips

**Start every feature with the ticket.** Before writing any code, pull in the ticket and ask C0 to walk through what's needed. This is faster than reading the ticket yourself and much better than half-remembering the requirements while implementing.

**Use tickets for bug context.** Bug tickets usually contain the best information about a bug reproduction steps, logs, screenshots, comments from QA. Pull the ticket into debug mode and C0 can read all of that automatically.


# Build

Build your applications effortlessly with the help of our build agent.

An AI studio for generating, previewing, and deploying full-stack applications from a browser no local setup required.

Build takes a natural language description and produces a complete, runnable application: frontend, backend, database schema, authentication, and deployment configuration. You can start from a text prompt, a visual design you generate in-product, or an imported Figma file.

The output is production-grade code you own. Download it, push it to GitHub, or deploy it directly to a shareable URL on CodeMate Cloud.

***

### How it works

A Build project follows four stages. Each one feeds into the next, and you can re-enter at any point.

**1. Describe**

Write a plain-language description of your app what it does, who uses it, and how it should look. The more specific you are about pages, flows, and user roles, the closer the first output will be to what you have in mind.

**2. Generate**

Build plans the architecture, then generates frontend and backend code together. You can watch this happen in the file explorer as files are created and populated in real time.

**3. Preview & iterate**

A live preview runs your app, Click through it, fill out forms, and check responsive layouts. Describe changes in the chat and they reflect immediately.

**4. Deploy**

Click **Deploy**. Your app is packaged and hosted on CodeMate Cloud. You get a public URL at `your-app.codemate.build` with HTTPS configured automatically.

***

### Starting modes

Every project begins in one of three modes. You can switch between them at any point project context is preserved across all three.

| Mode           | Input                   | Best for                                                      |
| -------------- | ----------------------- | ------------------------------------------------------------- |
| Conversational | Text prompt             | You know what you want to build and want to move fast         |
| Design mode    | UI description          | You want to nail the visual direction before writing any code |
| Figma import   | Figma file or frame URL | You have existing designs and want production code from them  |

***

### Exporting your code

All generated code is yours. From any project, open the file explorer and click **Export** to download a ZIP archive.

> Deployed apps on the free tier are public. Sensitive environment variables are injected at deploy time and never written to source files.


# Quickstart

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.

### Prerequisites

You need a CodeMate account on any plan, including free. No local tooling, runtime, or database setup is required everything runs in the browser.

<figure><img src="/files/jw47M3KCOD2ahO9JNDkq" alt=""><figcaption></figcaption></figure>

***

### Create a project

1. **Open Build and Write your first prompt**

Navigate to [Build](https://build.codemate.ai/build) and describe what you want to make. Be specific about pages, user roles, and any key features. A useful format:

```
Build a task manager where users can sign up, create projects,
add tasks with due dates and priority levels, and mark them
complete. Include a dashboard showing tasks due today.
```

2. **Review Generated Code**

Build will plan the architecture and generate files. The file explorer on the left shows the project structure as it's created. Click any file to inspect it.

3. **Test in the live preview**

The preview pane on the right runs your app live. Click through the UI, create test accounts, and verify flows work as expected. If something looks wrong, describe the fix in the chat.

4. **Deploy**

Click Deploy in the top-right corner. Choose a subdomain name, confirm, and your app will be live at `your-name.codemate.build` within a few seconds.

***

### Next steps

Once you have a running app, you can continue building by sending follow-up prompts add features, change the design, or connect a different database. See **Conversational build** for how iterative generation works, or **Design mode** if you want to redesign the UI before your next round of changes.


# Conversational build

Generate a complete full-stack codebase from a plain-language description, then extend it incrementally through follow-up prompts.

Conversational mode is the primary way to use Build. You describe what you want the app's purpose, its features, its users and Build produces a structured, working codebase. From there, the conversation continues: each follow-up prompt adds to or modifies the existing code rather than starting over.

***

### Initial generation

Your first prompt drives the entire architecture. Build reads it and produces a plan routes, data models, components, APIs before writing any code. You can see this plan in the chat before files start appearing.

A well-formed initial prompt describes:

* What the app does and who uses it
* The main pages or views
* Key features and workflows
* Any specific technical requirements (database, auth method, real-time features)

```
Build a project management tool where teams can create projects,
assign tasks to members, set due dates, and track progress with
a Kanban board. Include user authentication and email notifications
when a task is assigned.
```

You don't need to specify the full stack unless you have a preference. Build will choose sensible defaults and note them in its planning output.

***

### Iterating with follow-up prompts

After the initial generation, each prompt is treated as an instruction to modify the existing codebase. Build adds, changes, or removes code incrementally it doesn't regenerate from scratch.

```
Create an admin panel where site owners can manage users and revoke access.
```

```
Add CSV export component to the task table.
```


# Design mode

Generate high-fidelity UI designs from a natural language description, then refine them before exporting to code.

Design mode lets you establish a visual direction before any code is written. Describe the interface you want layout, color, components and Build produces a design you can review and iterate on. When you're satisfied, export it directly to the code generation pipeline.

No Figma account or design experience is required. If you do use Figma, see **Figma integration** instead.

<figure><img src="/files/jH9Fniea18JOOaOTWD82" alt=""><figcaption></figcaption></figure>

***

### Generating a design

Write a description of the UI you want. The more detail you include about layout, color scheme, and component types, the closer the initial output will be.

```
A SaaS analytics dashboard. Dark mode. Sidebar navigation with icons
and a collapsible state. Top bar with user avatar and notification bell.
Main area with four KPI cards, a line chart for monthly revenue, and
a table of recent transactions with status badges.
```

Build produces a complete layout structure, color palette, typography, spacing, and component composition rendered as a visual you can inspect directly.

***

### Refining with follow-ups

After the first output, continue the conversation to adjust any aspect of the design:

```
Switch the color scheme to indigo and slate. Make the sidebar collapsible.
Replace the line chart with a grouped bar chart.
```

```
Add a dark/light mode toggle to the top bar. Move the KPI cards below the chart.
```

Each refinement updates only what you describe the rest of the design is preserved.

***

### Exporting

Once the design looks right, you have three export options:

| Format      | Use it when                                                                                    |
| ----------- | ---------------------------------------------------------------------------------------------- |
| Image (PNG) | You need a static reference for sharing, presentations, or specs                               |
| HTML Code   | You're ready to generate the implementation the design is passed directly to the code pipeline |

***

### When to use design mode

Design mode produces better UI output than jumping straight to code with a text description. If visual quality matters a customer-facing product, a portfolio piece, or anything where layout and color are part of the brief spend time in design mode first. It acts as a specification that grounds the code generation.

If you already have designs in Figma, use **Figma integration** instead to import them directly.


# Figma integration

Turn any Figma design into a working fullstack application. Paste a link, click Import, and Build clones your design into production-ready code.

### Overview

Build reads your Figma design files and generates a fullstack application that matches the design components, layouts, styles, and assets included. There is no manual redrawing or component mapping. You give Build access to your Figma account once, paste the file link, and it handles the rest.

The workflow is three steps:

1. **Connect -** link your Figma account to Build using a Personal Access Token.
2. **Import -** paste your Figma file URL and click Import.
3. **Build -** click Start Building and get a working fullstack application.

<figure><img src="/files/Uh5h7mTuAspojV3SyWbx" alt=""><figcaption></figcaption></figure>

***

### Connecting your Figma account

Build authenticates with Figma via a Personal Access Token (PAT). You generate the token inside Figma and add it to Build once. After that, you can import any Figma file your account has access to.

#### Step 1 Generate a Figma PAT

1. Open [figma.com](https://figma.com) and click your **profile avatar** in the top-left corner.
2. Go to **Settings → Security → Personal access tokens**.
3. Click **Generate new token**.
4. Give the token a name for example, `CodeMate Build`  so you can identify it later.
5. Click **Generate** and **copy the token immediately**. Figma will not show it again after you close the dialog.

> **Keep your PAT secure.** Treat it like a password. Do not share it, commit it to a repository, or store it in plaintext. You can revoke it at any time from **Figma Settings → Personal access tokens**.

#### Step 2 Connect the token in Build

1. Open **Build** from within CodeMate Toolbox or [Click here](https://build.codemateai.dev/build).
2. Click on Figma Project toggle.
3. Paste your PAT into the token field and click **Connect**.
4. Build verifies the token with Figma and shows a confirmation once the connection is active.

***

### Importing a design

Once your Figma account is connected, importing a design takes under a minute.

1. Open the Figma file you want to import in your browser.
2. Copy the URL from the address bar. It will look like this:

   ```
   https://www.figma.com/file/XXXXXXXXXXXXXX/Your-Project-Name
   ```
3. In Build, paste the URL into the **Figma URL** field.
4. Click **Import**. Build fetches the file for you.
5. Now you can sit back and Build will turn your figma design into a working fullstack website.

The generated project is ready to preview, edit, and deploy directly inside Build.

***

### Getting the best results in Figma

The quality of generated code depends on how the Figma file is structured. A few practices make a meaningful difference:

**Use Auto Layout throughout.** Frames without Auto Layout produce less predictable CSS. Build works best when spatial relationships are defined with Auto Layout rather than manual positioning.

**Name your layers clearly.** `Sidebar`, `NavItem`, `CardHeader`  layer names become React component names in the generated code. Generic names like `Frame 42` or `Group 7` produce generic, harder-to-maintain output.

**Use Figma Styles for colors and typography.** Define your colors and text styles as Figma Styles rather than per-layer overrides. Build converts them into reusable design tokens or Tailwind config values.

**Design at 1440px for desktop.** If you need responsive output, include a separate mobile frame at 390px alongside your desktop frame. Build will generate responsive CSS rules when both frames are present.

**Avoid deeply nested groups.** Deeply nested groups where Auto Layout would work better generate fragile absolute positioning. Flatten your structure where possible.

***

> **Need help?** Reach out to the CodeMate team via the in-app contact option inside Toolbox, or visit [app.codemate.ai](https://app.codemate.ai).


# Deployment

Publish your app to a managed cloud environment and get a shareable public URL in seconds.

Build handles packaging, hosting, SSL, and environment variable injection no server, CDN, or CI/CD pipeline required.

***

### Auto Deployment

Every project in Build gets an automatically deployed public URL. Your app is live on a `*.codemate.build` subdomain as you work no configuration needed, shareable in seconds.

***

### Deploying with a Custom Subdomain

To publish your app under a specific name:

1. In Build, click **Settings** in the top-right corner of the preview pane.
2. Choose a subdomain name for your app (e.g. `my-saas-app`).
3. Confirm the deployment. Build packages and publishes your app. A public URL is ready within seconds.

`https://my-saas-app.codemate.build`

> Available on Pro and Team plans.

### Transfer to Netlify

For full infrastructure control, advanced routing, or enterprise-grade hosting, export your project directly to Netlify. Go to **Settings → Transfer to Netlify** to package and deploy your project to your Netlify account.

> Available on Pro and Team plans.

***


# Writing prompts

How to write initial and follow-up prompts that produce better output.

The quality of what Build generates is directly tied to the quality of the prompt. This page covers what to include in an initial prompt and how to phrase follow-ups for precise iterative changes.

***

### Initial prompts

An initial prompt should describe the app in enough detail that Build can make confident decisions about architecture. You don't need to specify every detail, but the more you cover, the less Build has to guess.

Useful things to include:

* The app's core purpose in one or two sentences
* The main user roles and what each one does
* The key pages or views
* Any specific technical requirements (database, auth method, third-party integrations)
* Visual preferences, if they matter dark mode, a reference product, a color palette

**Example vague prompt**

```
Make a web app for managing tasks.
```

This works, but Build will make many assumptions. The output may not match what you had in mind.

**Example specific prompt**

```
Build a task manager for small teams. Users can sign up and belong
to a workspace. Inside a workspace, users can create projects and
add tasks with a title, description, due date, assignee, and priority
(low / medium / high). Tasks can be viewed in a list or Kanban board.
Include email notifications when a task is assigned. Dark mode by default.
```

This gives Build enough to make the right decisions on architecture, data model, and UI without over-constraining it.

***

### Follow-up prompts

Follow-ups are instructions to modify the existing codebase. Be specific about what you want changed and, if relevant, where.

| Instead of            | Try                                                                                                |
| --------------------- | -------------------------------------------------------------------------------------------------- |
| *Fix the dashboard*   | *The KPI cards on the dashboard are not aligned on mobile. Stack them vertically below 768px.*     |
| *Add payments*        | *Add Stripe Checkout for a single $29/month subscription plan. Redirect to /dashboard on success.* |
| *Make it look better* | *The sidebar feels cluttered. Remove the icon labels and increase the spacing between nav items.*  |

***

### Referencing real-world products

It's useful to reference an existing product as a visual or structural reference. Build understands these references and uses them to guide layout and interaction patterns without copying them.

```
The dashboard layout should feel similar to Linear clean, minimal,
keyboard-navigable, with a command palette.
```

```
The onboarding flow should work like Notion's one step at a time,
no forced sign-up before showing the product.
```


# Iterative building

How to build complex applications incrementally without overloading a single prompt.

Trying to describe a complete product in one prompt rarely produces the best result. Build works better when you treat it like a development process start with a working core, then add layers.

***

### The phased approach

Break the product into phases based on what needs to exist before the next thing can be built. Each phase produces something testable.

```
Phase 1: User auth, a basic task list, and a project structure.
Phase 2: Due dates, priority levels, and assignees on tasks.
Phase 3: A Kanban board view with drag-and-drop.
Phase 4: Email notifications for task assignments and due date reminders.
```

This pattern works because each phase has a clear scope. Build can make reliable architectural decisions within that scope, and you can verify the result before committing to the next step.

***

### Design before code

If UI quality matters, use Design mode to establish the visual direction before any code is written. Once the design looks right, export it to the code pipeline. This produces significantly better UI output than describing the design and code together in a single prompt.

A practical sequence:

```
1. Use Design mode to generate and refine the UI.
2. Export the design to the code pipeline.
3. Add backend logic, auth, and data layer via follow-up prompts.
4. Connect the frontend to real data.
```

***

### Testing between phases

Use the live preview to verify each phase before moving to the next. It's much easier to fix an issue in isolation before the next layer of complexity is added than to debug it later when more code is involved.

Describe bugs directly from the preview rather than trying to locate them in the file explorer. Build understands descriptions like "clicking the delete button doesn't remove the item from the list" and will find the relevant code.

***

### Figma workflow

If you're working from Figma designs, the recommended sequence is:

```
1. Structure the Figma file with Auto Layout and named layers.
2. Import the file into Build.
3. Review the generated components in the preview.
4. Add interactivity, routing, and data via follow-up prompts.
```

See **Figma integration** for more on preparing your Figma file for the best results.


# Community spotlight

A curated gallery of real apps built by the CodeMate community, with live demos and cloneable templates.

### What's in the spotlight

The spotlight is a way to see what Build is capable of in practice and to skip the blank canvas by starting from something that already works.

***

### Categories

| Category       | Examples                                              |
| -------------- | ----------------------------------------------------- |
| SaaS tools     | Lead Intelligence System Research Showcase            |
| AI apps        | Code Chronicles - GitHub Year in Review               |
| Internal tools | Nexus Enterprise HR Operations Dashboard              |
| Productivity   | airShare - Collaborative Real-Time Expense Management |
| E-commerce     | NeonPulse - Immersive Concert Booking Platform        |
| Ed-tech        | Sanatan Wisdom Hub                                    |

{% hint style="info" %}
Click on any project in Build’s Community tab to view the live demo
{% endhint %}


# CodeMate for Education

**CodeMate for Education** is an academic initiative aimed at integrating AI-driven development tools into the learning journey of students, educators, and institutions. It extends the power of CodeMate's intelligent coding agents to classrooms, coding clubs, and universities enabling a new era of smarter, faster, and more effective software development education.

This program is built to support the complete academic ecosystem - from individual learners to institutional teaching workflows - while maintaining the rigor and standards expected in real-world development environments.

***

#### Why CodeMate Stepped into Education

The gap between academic learning and industry readiness is one of the biggest challenges in computer science education. Students graduate with theoretical knowledge but often lack exposure to modern tooling, workflows, and collaborative development practices. CodeMate for Education bridges this gap by:

* Introducing AI-assisted development to learners early in their careers
* Helping educators focus on concepts rather than repetitive debugging sessions
* Standardizing access to cutting-edge tools regardless of institutional resources
* Aligning academic projects with real-world engineering standards

***

#### Learn Anywhere, Even Offline

CodeMate for Education is built with accessibility in mind. Offline compatibility support ensures that students and educators in low-connectivity environments are never left behind. Core features remain functional without a stable internet connection, with changes syncing automatically once connectivity is restored making uninterrupted learning possible.

***

#### Key Highlights

* **Full suite of AI-powered development features**: From debugging and code reviews to refactoring and test case generation using the CodeMate AI assistant in Playground
* **Educator-focused capabilities**: Assignment code review, and student performance tracking.
* **Build agent access**: Simplify project scaffolding and reduce the overhead of boilerplate coding.
* **Integrated support**: Available through the CodeMate Web App and offline integration (soon)
* **Preferential access for academic use**: Free and subsidized plans for eligible students, clubs, and institutions.

***

#### Who Can Benefit

* [**Students**](https://docs.codemate.ai/codemate-for-education/for-students) seeking intelligent assistance and learning-by-doing support while writing or reviewing code.
* [**Educators**](https://docs.codemate.ai/codemate-for-education/for-institutions) looking to integrate AI-enhanced tools into coursework, projects, or live coding sessions.
* [**Campus communities and clubs**](https://docs.codemate.ai/codemate-for-education/campus-clubs-and-ambassadors) aiming to empower their members with industry-ready tools.
* [**Institutions**](https://docs.codemate.ai/codemate-for-education/for-institutions) planning to modernize their software development curriculum with scalable, AI-supported infrastructure.

**CodeMate for Education** is an academic initiative aimed at integrating AI-driven development tools into the learning journey of students, educators, and institutions. It extends the power of CodeMate's intelligent coding agents to classrooms, coding clubs, and universities enabling a new era of smarter, faster, and more effective software development education.

This program is built to support the complete academic ecosystem from individual learners to institutional teaching workflows while maintaining the rigor and standards expected in real-world development environments.

***

#### Why CodeMate Stepped into Education

The gap between academic learning and industry readiness is one of the biggest challenges in computer science education. Students graduate with theoretical knowledge but often lack exposure to modern tooling, workflows, and collaborative development practices. CodeMate for Education bridges this gap by:

* Introducing AI-assisted development to learners early in their careers
* Helping educators focus on concepts rather than repetitive debugging sessions
* Standardizing access to cutting-edge tools regardless of institutional resources
* Aligning academic projects with real-world engineering standards

***

#### Learn Anywhere, Even Offline

CodeMate for Education is built with accessibility in mind. Offline compatibility support ensures that students and educators in low-connectivity environments are never left behind. Core features remain functional without a stable internet connection, with changes syncing automatically once connectivity is restored making uninterrupted learning possible.

***

#### Key Highlights

* **Full suite of AI-powered development features**: From debugging and code reviews to refactoring and test case generation using the CodeMate AI assistant in Playground
* **Educator-focused capabilities**: Assignment code review, and student performance tracking.
* **Build agent access**: Simplify project scaffolding and reduce the overhead of boilerplate coding.
* **Integrated support**: Available through the CodeMate Web App and offline integration (soon)
* **Preferential access for academic use**: Free and subsidized plans for eligible students, clubs, and institutions.

***

#### Who Can Benefit

* [**Students**](https://docs.codemate.ai/codemate-for-education/for-students) seeking intelligent assistance and learning-by-doing support while writing or reviewing code.
* [**Educators**](https://docs.codemate.ai/codemate-for-education/for-institutions) looking to integrate AI-enhanced tools into coursework, projects, or live coding sessions.
* [**Campus communities and clubs**](https://docs.codemate.ai/codemate-for-education/campus-clubs-and-ambassadors) aiming to empower their members with industry-ready tools.
* [**Institutions**](https://docs.codemate.ai/codemate-for-education/for-institutions) planning to modernize their software development curriculum with scalable, AI-supported infrastructure.


# For Students

CodeMate for Education gives every student a dedicated learning environment built around how you actually study, code, and grow. Your student dashboard is your academic command center everything your instructor shares, every assignment you need to complete, every milestone you've hit, and an AI assistant ready to help you through it all, in one place.

***

#### My Progress

Your Progress dashboard gives you a real-time view of where you stand across all your enrolled courses and assignments. No more guessing whether you're on track.

What you can track:

* Daily activity chart
* Assignment submission status pending, submitted, graded
* Scores and instructor feedback on completed work
* Skill tags showing which concepts you've practiced (e.g., Arrays, REST APIs, Web Fundamentals)

***

#### Resources

Your Resources hub is where all course materials live. Instructors upload files directly to your program, and you can access them anytime, from any device no hunting through emails or group chats.

What you'll find here:

* Lecture notes, slides, and reading materials shared by your instructor
* Starter code files and project templates for assignments
* Reference sheets, cheat sheets, and supplementary guides
* Organized by course, module, or topic

***

#### Assignments

The Assignments section is where your coursework lives. View everything assigned to you, track deadlines, and submit your work all without leaving the platform.

Each assignment includes:

* A clear description of what's expected, written by your instructor
* Any attached starter files or reference materials
* A deadline so you always know how much time you have
* A built-in code editor or file upload option depending on the assignment type
* Submission history so you can see what you've previously submitted

**How it works:**

1. Open an assignment from your dashboard or the Assignments tab
2. Work on your solution in the platform editor
3. Submit your code or files before the deadline
4. Receive instructor feedback and your grade directly in the platform

***

#### Edu Chat

Edu Chat is your always-on AI study assistant, built specifically for the CodeMate Education platform. It's not a generic chatbot it's context-aware, course-aware, and designed to help you learn, not just give you answers.

What Edu Chat can do:

* Answer questions about concepts covered in your assignment
* Help you understand why your code isn't working
* Walk you through assignment requirements if something isn't clear
* Explain error messages and suggest where to look for the issue

***

Your student dashboard, your resources, your progress, your assignments, and your AI assistant all in one place. That's CodeMate for Education.

CodeMate for Education gives every student a dedicated learning environment built around how you actually study, code, and grow. Your student dashboard is your academic command center everything your instructor shares, every assignment you need to complete, every milestone you've hit, and an AI assistant ready to help you through it all, in one place.

***

#### My Progress

Your Progress dashboard gives you a real-time view of where you stand across all your enrolled courses and assignments. No more guessing whether you're on track.

What you can track:

* Daily activity chart
* Assignment submission status pending, submitted, graded
* Scores and instructor feedback on completed work
* Skill tags showing which concepts you've practiced (e.g., Arrays, REST APIs, Web Fundamentals)

***

#### Resources

Your Resources hub is where all course materials live. Instructors upload files directly to your program, and you can access them anytime, from any device no hunting through emails or group chats.

What you'll find here:

* Lecture notes, slides, and reading materials shared by your instructor
* Starter code files and project templates for assignments
* Reference sheets, cheat sheets, and supplementary guides
* Organized by course, module, or topic

***

#### Assignments

The Assignments section is where your coursework lives. View everything assigned to you, track deadlines, and submit your work all without leaving the platform.

Each assignment includes:

* A clear description of what's expected, written by your instructor
* Any attached starter files or reference materials
* A deadline so you always know how much time you have
* A built-in code editor or file upload option depending on the assignment type
* Submission history so you can see what you've previously submitted

**How it works:**

1. Open an assignment from your dashboard or the Assignments tab
2. Work on your solution in the platform editor
3. Submit your code or files before the deadline
4. Receive instructor feedback and your grade directly in the platform

***

#### Edu Chat

Edu Chat is your always-on AI study assistant, built specifically for the CodeMate Education platform. It's not a generic chatbot it's context-aware, course-aware, and designed to help you learn, not just give you answers.

What Edu Chat can do:

* Answer questions about concepts covered in your assignment
* Help you understand why your code isn't working
* Walk you through assignment requirements if something isn't clear
* Explain error messages and suggest where to look for the issue

***

Your student dashboard, your resources, your progress, your assignments, and your AI assistant all in one place. That's CodeMate for Education.


# For Institutions

Transform how your programs teach modern software development.

CodeMate for Education gives institutions a scalable, AI-powered environment to manage coding education across classrooms. Whether you're running a small cohort or a large program with multiple instructors, the platform is built to reduce operational overhead while raising the quality of student outcomes.

***

#### AI-Assisted Review at Scale

One of the core challenges institutions face is the volume of code submissions that need meaningful feedback. CodeMate addresses this through bulk review tooling AI agents that analyze multiple submissions simultaneously, flagging logical errors, reviewing code structure, and generating improvement suggestions. Instructors no longer need to manually check through every submission to identify common issues. The AI handles the first pass; educators handle the judgment calls.

***

#### Evaluation Built Around Your Academic Standards

Every institution has its own definition of what good code looks like. The platform lets you define custom review metrics aligned to your specific academic goals whether that's clean architecture, documentation practice, test coverage, or domain-specific conventions. These criteria are applied consistently across all student work, so evaluation reflects what your program actually values, not a generic rubric.

***

#### Supporting Students Without Overloading Instructors

Students can get AI-assisted help debugging and optimizing their projects directly within the platform, without needing to wait for instructor availability. This keeps students unblocked and learning continuously, while significantly reducing the volume of repetitive support requests that instructors field. The result is more meaningful instructor-student interactions focused on deeper concepts rather than surface-level syntax issues.

***

#### Visibility Across Student Groups

Institutions get code quality and performance metrics tracked across cohorts, making it possible to compare progress between groups, identify where students are consistently struggling, and make curriculum adjustments based on real data rather than end-of-term grades alone.

***

#### Institutional Benefits

* Reduced teaching overhead on repetitive debugging and feedback
* Improved coding outcomes and better student performance tracking
* Scalable infrastructure that integrates into existing tools and workflows

CodeMate for Education gives institutions a scalable, AI-powered environment to manage coding education across classrooms. Whether you're running a small cohort or a large program with multiple instructors, the platform is built to reduce operational overhead while raising the quality of student outcomes.

***

#### AI-Assisted Review at Scale

One of the core challenges institutions face is the volume of code submissions that need meaningful feedback. CodeMate addresses this through bulk review tooling AI agents that analyze multiple submissions simultaneously, flagging logical errors, reviewing code structure, and generating improvement suggestions. Instructors no longer need to manually check through every submission to identify common issues. The AI handles the first pass; educators handle the judgment calls.

***

#### Evaluation Built Around Your Academic Standards

Every institution has its own definition of what good code looks like. The platform lets you define custom review metrics aligned to your specific academic goals whether that's clean architecture, documentation practice, test coverage, or domain-specific conventions. These criteria are applied consistently across all student work, so evaluation reflects what your program actually values, not a generic rubric.

***

#### Supporting Students Without Overloading Instructors

Students can get AI-assisted help debugging and optimizing their projects directly within the platform, without needing to wait for instructor availability. This keeps students unblocked and learning continuously, while significantly reducing the volume of repetitive support requests that instructors field. The result is more meaningful instructor-student interactions focused on deeper concepts rather than surface-level syntax issues.

***

#### Visibility Across Student Groups

Institutions get code quality and performance metrics tracked across cohorts, making it possible to compare progress between groups, identify where students are consistently struggling, and make curriculum adjustments based on real data rather than end-of-term grades alone.

***

#### Institutional Benefits

* Reduced teaching overhead on repetitive debugging and feedback
* Improved coding outcomes and better student performance tracking
* Scalable infrastructure that integrates into existing tools and workflows


# Campus Clubs and Ambassadors

Lead your campus. Build community. Shape the future of coding education.

CodeMate partners with university developer communities to bring AI-enhanced software development practices directly to campus. Whether you're running a coding club, organizing hackathons, or building a community of developers who want to stay ahead of the curve, CodeMate gives you the tools, resources, and backing to make it happen at scale.

***

#### What We Offer

* **Free EDU Access**: Every club member and student contributor gets full access to CodeMate's AI-powered development environment at no cost, so your community can build, experiment, and learn without any barriers to entry.
* **Event Support**: Planning a workshop, hackathon, or tech talk? We provide resources, licenses, and ready-to-use content so you spend less time on logistics and more time on creating meaningful experiences for your community. From AI fundamentals sessions to full-day coding sprints, we help you run events that actually teach something.
* **Campus Ambassador Program**: Take on a leadership role as a CodeMate Campus Ambassador. Represent CodeMate at your institution, drive outreach initiatives, and earn recognized certifications along the way. Ambassadors receive exclusive benefits, early access to new features, and direct support from the CodeMate team making it a strong addition to any developer's profile.
* **Showcase Your Work**: Projects built using CodeMate have the opportunity to be featured across community highlights, case studies, and CodeMate's broader network. It's a chance for your club's work to reach an audience well beyond campus.

***

#### Why It Matters

Campus clubs are where some of the best early engineering talent develops. The transition from academic coding to real-world, AI-assisted development workflows is one of the most valuable things a student community can facilitate and that is exactly what this partnership is designed to support. Clubs that partner with CodeMate don't just get a tool, they get a development culture that prepares members for how software is actually being built today.

***

#### Eligibility

* Active campus tech clubs or developer communities with a genuine interest in AI and software development
* Student leads looking to grow in technical evangelism, community building, or developer advocacy
* A willingness to host events, engage your campus community, and share learnings from using CodeMate

***

#### Get Involved

If your club or community is ready to bring AI-powered development to your campus, we'd love to hear from you. Reach out to us at <contact@codemate.ai> and let's build something together.

CodeMate partners with university developer communities to bring AI-enhanced software development practices directly to campus. Whether you're running a coding club, organizing hackathons, or building a community of developers who want to stay ahead of the curve, CodeMate gives you the tools, resources, and backing to make it happen at scale.

***

#### What We Offer

* **Free EDU Access**: Every club member and student contributor gets full access to CodeMate's AI-powered development environment at no cost, so your community can build, experiment, and learn without any barriers to entry.
* **Event Support**: Planning a workshop, hackathon, or tech talk? We provide resources, licenses, and ready-to-use content so you spend less time on logistics and more time on creating meaningful experiences for your community. From AI fundamentals sessions to full-day coding sprints, we help you run events that actually teach something.
* **Campus Ambassador Program**: Take on a leadership role as a CodeMate Campus Ambassador. Represent CodeMate at your institution, drive outreach initiatives, and earn recognized certifications along the way. Ambassadors receive exclusive benefits, early access to new features, and direct support from the CodeMate team making it a strong addition to any developer's profile.
* **Showcase Your Work**: Projects built using CodeMate have the opportunity to be featured across community highlights, case studies, and CodeMate's broader network. It's a chance for your club's work to reach an audience well beyond campus.

***

#### Why It Matters

Campus clubs are where some of the best early engineering talent develops. The transition from academic coding to real-world, AI-assisted development workflows is one of the most valuable things a student community can facilitate and that is exactly what this partnership is designed to support. Clubs that partner with CodeMate don't just get a tool, they get a development culture that prepares members for how software is actually being built today.

***

#### Eligibility

* Active campus tech clubs or developer communities with a genuine interest in AI and software development
* Student leads looking to grow in technical evangelism, community building, or developer advocacy
* A willingness to host events, engage your campus community, and share learnings from using CodeMate

***

#### Get Involved

If your club or community is ready to bring AI-powered development to your campus, we'd love to hear from you. Reach out to us at <contact@codemate.ai> and let's build something together.


# Apply to CodeMate for Education

Get started in minutes. Access begins immediately upon verification.

Whether you're a student looking for a smarter way to learn, an educator aiming to bring AI-assisted coding into your classroom, or an institution ready to deploy at scale, CodeMate for Education has a dedicated access path for you.

***

#### Application Categories

* **Students** — Get access to a full AI-powered learning environment with a personal dashboard, course resources, assignment tools, an always-on AI study assistant, and real-time progress tracking. Must be currently enrolled in a recognized institution.
* **Educators** — Apply for classroom deployment with tools to create and manage AI-assisted assignments across ML, coding, and web categories, define custom evaluation metrics, review student submissions at scale, override AI-generated scores, access per-student evaluation reports, and monitor Edu Chat conversations to understand where your class needs support.
* **Institutions** — For department-level or full-campus access. Includes bulk submission review, custom academic metrics, code quality monitoring across student groups, multi-user license provisioning, and scalable infrastructure that integrates into your existing tools and workflows.
* **Campus Clubs & Ambassadors** — Apply for access to event materials, community support, and club-level features to bring CodeMate's ecosystem to your campus community.

***

#### How to Apply

1. Visit [edu.codemate.ai/org-login](https://edu.codemate.ai/org-login)
2. Submit the required information and any relevant verification details
3. Await confirmation within 5–7 business days

Whether you're a student looking for a smarter way to learn, an educator aiming to bring AI-assisted coding into your classroom, or an institution ready to deploy at scale, CodeMate for Education has a dedicated access path for you.

***

#### Application Categories

* **Students** — Get access to a full AI-powered learning environment with a personal dashboard, course resources, assignment tools, an always-on AI study assistant, and real-time progress tracking. Must be currently enrolled in a recognized institution.
* **Educators** — Apply for classroom deployment with tools to create and manage AI-assisted assignments across ML, coding, and web categories, define custom evaluation metrics, review student submissions at scale, override AI-generated scores, access per-student evaluation reports, and monitor Edu Chat conversations to understand where your class needs support.
* **Institutions** — For department-level or full-campus access. Includes bulk submission review, custom academic metrics, code quality monitoring across student groups, multi-user license provisioning, and scalable infrastructure that integrates into your existing tools and workflows.
* **Campus Clubs & Ambassadors** — Apply for access to event materials, community support, and club-level features to bring CodeMate's ecosystem to your campus community.

***

#### How to Apply

1. Visit [edu.codemate.ai/org-login](https://edu.codemate.ai/org-login)
2. Submit the required information and any relevant verification details
3. Await confirmation within 5–7 business days


# Courses

The Courses page is the central space where education comes together educators build and manage their programs, and students find, enroll in, and work through everything they need to complete them.

***

#### For Educators

Educators can create courses from the ground up, defining the structure, curriculum, and content that students will follow. Once a course is live, instructors can add resources, assignments, and learning material directly into it, keeping everything organized and accessible in one place.

A live view of enrolled students lets educators know exactly who is in their course at any given time, and the built-in leaderboard gives an at-a-glance picture of how the cohort is performing making it easy to spot engagement levels and track progress across the group without digging through individual records.

***

#### For Students

Students can browse and enroll in available courses directly from the Courses page. Once enrolled, they get full visibility into the curriculum what topics are covered, how the course is structured, and what is expected from start to finish.

From there, everything needed to complete the course is in one place: resources shared by the instructor, assignments to work through, and progress indicators that show how far along they are and what still needs to be done.

***

#### Built for the Way Coding Is Actually Learned

Most course platforms treat coding as content delivery. CodeMate treats it as a practice environment. Every course on the platform is backed by live code editors, AI-assisted feedback, bulk evaluation tools, and structured reporting meaning the gap between learning a concept and applying it is as small as possible.

For institutions, this translates to measurable outcomes. For students, it means a course that actively helps them get better, not just get through it.

Whether you are building a course or working through one, the Courses page is where the learning journey begins and is tracked all the way to completion.


# Frequently Asked Questions

Answers to the most common questions about CodeMate for Education

### Who is eligible for CodeMate for Education?

Students, instructors/educators, and verified institutions can apply. Campus clubs are also encouraged to join through the ambassador program.

### Is the CodeMate EDU version different from the standard platform?

No, EDU users receive access to the same professional-grade AI tools, but with added support and features relevant to academic use.

### Are there any costs involved?

Students and clubs can access EDU features for free, subject to verification. Institutions may receive custom deployment plans based on size and requirements.

### What support is provided to educators?

Educators receive access to review dashboards, group analytics, and the ability to manage student teams for assignment workflows.

### Can CodeMate be integrated into a Learning Management System (LMS)?

LMS integrations are in progress. Contact us at **<edu@codemate.ai>** to discuss your institutional needs.


# Pull Request Review Agent

Integrated with your version control (Github/Bitbucket/Gitlab/Azure-devops).

CodeMate is an AI-powered Pull Request review agent that integrates seamlessly into your version control workflow. It automatically analyzes pull requests for correctness, maintainability, security, and performance, then posts clear, structured comments and actionable suggestions directly on your PRs. Designed to help engineering teams ship higher-quality code faster, CodeMate is currently available exclusively as an **Enterprise solution**.

<figure><img src="/files/qtcpGe5LEKDTgV99Ut0h" alt=""><figcaption></figcaption></figure>

***

### Automatic Triggers

When a PR is **opened**, **reopened**, **marked ready for review**, or **synchronized** (new commit pushed), CodeMate automatically runs three commands in sequence:

| Step | Command     | What it does                                                                 |
| ---- | ----------- | ---------------------------------------------------------------------------- |
| 1    | `/describe` | Generates a PR title, type, summary, code walkthrough, and file change table |
| 2    | `/review`   | Reviews the PR for issues, security concerns, and estimates review effort    |
| 3    | `/improve`  | Suggests code improvements inline                                            |

Each of these can be re-triggered manually at any time by posting the corresponding command as a PR comment.

***

### Commands

Post any of the following as a comment on a PR to trigger the corresponding action:

#### `/describe`

Generates a structured PR description including title, type (bug fix / feature / refactor / etc.), a plain-English summary, a file-by-file change walkthrough, and labels. The description is published directly to the PR body (or as a persistent comment if configured that way).

#### `/review`

Performs a full AI review of the PR diff. Outputs:

* Key issues to review
* Estimated effort to review (1–5 scale, also applied as a label)
* Security concerns flag
* General feedback

The review comment is updated in place each time `/review` is re-run, keeping the PR thread clean.

#### `/improve`

Generates concrete, actionable code suggestions for the PR. Each suggestion includes:

* A one-sentence summary
* The existing code
* The improved code (as a GitHub suggestion block, so it can be applied with one click)
* A category label (e.g. "possible issue", "maintainability", "performance")
* An importance score (1–10)

Suggestions are grouped by category and sorted by score. Previous suggestion comments are preserved in a collapsible history section.

#### `/ask <question>`

Answers a free-text question about the PR or the code it touches. Supports image links embedded in the question for visual context.

**Example:** `/ask Why is this function called twice?`

#### `/update_changelog`

Generates or updates `CHANGELOG.md` based on the PR content. Outputs the suggested entry as a PR comment by default; can be configured to commit the file directly to the branch.

#### `/add_docs`

Generates documentation (docstrings, JSDoc, Javadoc, Doxygen, etc.) for functions, methods, and classes changed in the PR. Posted as inline GitHub suggestion blocks.

#### `/generate_labels`

Analyses the PR and suggests appropriate GitHub labels based on its content and any custom label definitions you have configured.

#### `/help`

Posts a summary of all available commands and their descriptions directly on the PR.

***

### Self-Hosted Setup

CodeMate offers a fully self-hosted deployment option, allowing organizations to run the PR Agent entirely within their own infrastructure.

This approach provides greater control over data privacy, security, and compliance, while eliminating dependency on external SaaS services. It enables seamless integration with existing internal tools, custom security policies, and on-premise environments, making it ideal for enterprises with strict regulatory requirements or air-gapped setups.

### Support

Email us at <contact@codemate.ai>


# CodeMate Terminal

**CodeTerm AI** is an open-source, AI-powered terminal designed to enhance the command-line experience for developers. It seamlessly integrates natural language processing capabilities, allowing users to execute commands, generate code, and interact with their codebase using plain English, all within the terminal environment.

### Key Features

#### 1. Natural Language to Command Conversion

Transform everyday language into precise terminal commands effortlessly.&#x20;

This feature eliminates the need to memorize complex command syntax, streamlining your workflow.

#### 2. AI-Powered Chat Interface

Engage in real-time conversations with the integrated AI assistant to:

* Generate code snippets.
* Seek explanations for code segments.
* Obtain recommendations for code optimization.

This chat interface ensures that assistance is always at your fingertips without leaving the terminal.

#### 3. Command Autocomplete

Boost productivity with intelligent command suggestions as you type, reducing errors and saving time.

#### 4. Privacy-Focused Design

CodeTerm AI prioritizes user privacy:

* Operates locally without transmitting data externally.
* Ensures that your code and commands remain confidential.

#### 5. Cross-Platform Compatibility

Available across major operating systems and shells, including:

* **Operating Systems:** Windows, macOS, Linux.
* **Shells:** Bash, Zsh, PowerShell, Command Prompt.

### Getting Started

#### Installation

To install CodeTerm AI, follow these steps:

1. **Download the Installer:**

   Visit the [official download page](https://cli.codemate.ai/#learnmore) and select the appropriate installer for your operating system.
2. **Run the Installer:**

   Execute the downloaded file and follow the on-screen instructions to complete the installation.
3. **Verify Installation:**

   Open your terminal and run:

   ```bash
   codeterm --version
   ```

   You should see the installed version number displayed.

#### Basic Usage

Once installed, you can start using CodeTerm AI:

* **Natural Language Commands:**

  Simply type your request in plain English:

  ```bash
  > find all large files in downloads
  ```

  CodeTerm AI will interpret and execute the corresponding command.
* **AI Chat:**

  Initiate a chat session:

  ```bash
  > codeterm chat
  ```

  Engage with the AI assistant for code generation, explanations, and more.

### Support and Resources

* **Documentation:** [docs.codemate.ai](https://docs.codemate.ai/)
* **GitHub Repository:** [github.com/CodeMate-AI/codeterm](https://github.com/CodeMate-AI/codeterm)


# FAQ's

### Frequently Asked Questions

**Q1: What is CodeTerm AI?**

A: CodeTerm AI is an AI-enhanced terminal that allows users to execute commands and interact with their codebase using natural language.

**Q2: How does CodeTerm AI ensure data privacy?**

A: All operations are performed locally on your machine, ensuring that your data remains private and secure.

**Q3: Is CodeTerm AI open-source?**

A: Yes, CodeTerm AI is open-source. You can view and contribute to the source code on [GitHub](https://github.com/CodeMate-AI/codeterm).

**Q4: What operating systems does CodeTerm AI support?**

A: CodeTerm AI is compatible with macOS, and Linux operating systems. However we will be launching for Windows super soon!<br>

### Support and Resources

* **Documentation:** [docs.codemate.ai](https://docs.codemate.ai/)
* **GitHub Repository:** [github.com/CodeMate-AI/codeterm](https://github.com/CodeMate-AI/codeterm)


# Feature walkthrough

Learn how to setup CodeMate within the following surfaces & get a tour of the features in each of them:

### &#x20;<picture><source srcset="/files/yw1NHK9OrHWMSsPXO5ZX" media="(prefers-color-scheme: dark)"><img src="/files/9ZtBt4G8r9t9N8bao5HF" alt="" data-size="line"></picture>  CodeMate Toolbox

### <picture><source srcset="/files/j2BRZQnpeMzHANNSt2pe" media="(prefers-color-scheme: dark)"><img src="/files/00YCMV7GkmH4QNYHIL3y" alt="" data-size="line"></picture> CodeMate C0

### <img src="/files/9ZtBt4G8r9t9N8bao5HF" alt="" data-size="line">  [CodeMate Terminal](https://cli.codemate.ai/)

### 🎓[CodeMate for Education](https://codemate.ai/edu)


# VS Code Extension

Welcome to the official walkthrough guide for the **CodeMate VS Code Extension**. This guide will help you install, set up, and explore the full suite of AI-powered features that come bundled with CodeMate.

### Prerequisites

Before getting started, ensure the following:

* You have an active CodeMate account at [https://codemate.ai](https://codemate.ai/).
* You have Visual Studio Code installed on your system.

### Installation Guide

1. Launch Visual Studio Code.
2. Click on the Extensions icon in the Activity Bar.
3. Search for `CodeMate AI` and click **Install**.
4. Once installed, you will see the CodeMate icon in the left panel

> ⚠️ Can't find it? You can also install it directly from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=AyushSinghal.Code-Mate).

#### &#x20;Sign In

* Click on the CodeMate profile icon.
* Click **Sign In** in the sidebar.
* You will be prompted with an authentication screen. Use your preferred(Google, Miscrosoft, Github or Email) method to log in.
* Once signed in, return to VS Code to start using CodeMate.

### Feature Walkthrough

#### CodeMate Chat

An intelligent AI assistant inside VS Code. Accessible as a sidebar panel:

* Ask queries in natural language.
* Use `/commands` for features and `@` for Knowledge Base references.
* Toggle **Web Browsing** for real-time info.
* Use **Attach File** for context-specific answers.

> 💡 **Use Case**: Ask "Refactor this file" while attaching a JavaScript file.

📸 *Place Screenshot of Chat Pane Here*

#### Knowledge Base

Store your code, documentation, or URLs to enhance contextual responses.

* **Import via URL**: Add website links with customizable depth.
* **Import GitHub Repo**: Sync a public or private repo.
* **Import Local Code**: Add files/folders from your system.

> 💡 **Use Case**: Add your docs website and ask questions from it.

📸 *Place Screenshot of Knowledge Base Pane with Items Added*

#### Debug Code Agent

Quickly find and fix issues in your code with AI.

* Highlight any code.
* Right-click and select **Debug Code with CodeMate**.
* The AI analyzes and suggests fixes inline.

📸 *Place Screenshot of Debug Agent in Action*

#### Code Review Agent

Get AI-powered feedback on your code:

* Click the lightbulb 💡 icon or right-click.
* Select **Review Code**.
* Receive improvements, bug alerts, and best practice feedback.

> 💡 Ideal for pull requests and code quality audits.

📸 *Place Before/After Code Review Example Image*

#### Optimize Code Agent

Make your code more efficient:

* Highlight a function or class.
* Right-click → **Optimize Code with CodeMate**.
* View optimized and explained output.

📸 *Place Side-by-Side of Original vs Optimized Code*

#### Generate Test Cases Agent

Automate test case creation:

* Highlight a function.
* Use the context menu to select **Generate Test Cases**.
* View a list of unit tests, edge cases, and boundary inputs.

> 💡 Saves time while ensuring test coverage.

📸 *Insert Screenshot Showing Test Case Suggestions*

#### Generate Docstrings

Automatically document your code:

* Highlight a function/class.
* Choose **Generate Docstring**.
* CodeMate inserts a structured, docstring in your format (Google/NumPy style).

📸 *Show Before/After of a Function with Generated Docstring*

#### Swagger Agent

Turn Swagger/OpenAPI specs into ready backend code:

* Open the CodeMate Panel → Swagger Agent.
* Upload a spec file or URL.
* Choose target language (e.g. Flask, Express.js).
* Add instructions like "Use JWT".

> 🔧 CodeMate generates backend code including routes, models, and handlers.

📸 *Insert Screenshot Showing Swagger Agent Output in Editor*

### Extension Settings

Navigate to `Settings > Extensions > CodeMate` to tweak preferences:

* **Pre-Instructions**: Customize how Chat, Debug, Optimize, and Review behave.
* **Enable/Disable Code Lens**: Toggle inline buttons for actions above functions.

📸 *Screenshot of Settings Panel Highlighting Options*

### Summary

CodeMate transforms your coding experience in VS Code with seamless AI-powered development tools-from chat to documentation, debugging, and even backend generation.


# CodeMate Web App

CodeMate Web App provides access to the core features of CodeMate outside of VS Code or Terminal. It can be accessed from any web browser across desktop or phone, which makes it easy to access CodeMate on the go.&#x20;

## Setup

To access the CodeMate Web App, simply navigate to <https://app.codemate.ai> in a new tab. The web app can also be installed as an application for quick access & opening in its own dedicated window.

Upon successful sign-in, the following interface will become visible:

<figure><img src="/files/JpmrSfbKEwurTL3DvrRL" alt=""><figcaption></figcaption></figure>

## Usage

CodeMate Web App comprises of the following components:

1. **Dashboard:**&#x20;

* **Profile**: View your name, role (e.g., AI/ML), license info, and your current coding streak.
* **Time Saved**: Tracks how many days/hours CodeMate has saved you by speeding up your development process.
* **Efficiency**: Shows how much more efficient you are compared to normal coding speed (as a %).
* **Lines of Code & Time Saved**: Graphical view of how many lines you’ve written and the time saved each month.
* **Activity Monitor**: Insights into your usage, including:
  * Number of reviews
  * Debugs
  * Optimizations
  * Token usage
* **Programming Language Breakdown**: Automatically detects and displays the percentage of code written in different languages (e.g., Python, JavaScript, JSX, HTML, etc.).

This dashboard helps you track progress, measure productivity, and stay motivated.

2. Build:

The **Build Agent** streamlines the creation of frontend applications by automating the entire project setup process. Instead of manually configuring folders, frameworks, and starter files, you can focus entirely on writing meaningful code - CodeMate takes care of the rest.

**Key Features**

* **Stack Selection**\
  Easily choose from a wide range of technology stacks (frontend, backend, or full-stack) based on your project requirements.
* **Automated Project Setup**\
  Generate boilerplate code, folder structures, and config files with a single click — no more repetitive scaffolding.
* **AI-Powered Customization**\
  Personalize and refine the generated code using AI agents to better align with your use case or coding preferences.

**Accessing the Feature**

You can launch the Build Agent directly from the **CodeMate Build Interface** within your dashboard.

<figure><img src="/files/OQd9PPZNLP4sEbvrNe2j" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/d0tgXoa1LMzbo5xG8NG8" alt=""><figcaption></figcaption></figure>

3. Chat: The CodeMate AI chat interface inside dashboard is a powerful tool designed to accelerate development workflows by providing real-time, intelligent assistance within your dashboard. Whether you're authoring new code, resolving bugs, or optimizing existing logic, this interface offers a seamless and contextual development experience.

<figure><img src="/files/B8UteEYb0YIZsXHFHLfp" alt=""><figcaption></figcaption></figure>

**3.1 Generate High-Quality Code**

**Description:**\
Translate natural language instructions into clean, functional, and production-ready code. This feature supports rapid prototyping, code scaffolding, and automation of routine programming tasks, significantly reducing manual effort and coding time.

**3.2 Ask Specific Questions About Your Code**

**Description:**\
Get accurate, context-aware answers to technical queries. Whether you're trying to understand a specific behavior, resolve a logic issue, or clarify a concept, this feature delivers reliable guidance tailored to your code and environment.

**3.3 Modify Existing Code**

**Description:**\
Submit your current codebase and describe the changes you want. From performance optimization and feature enhancements to bug fixes and refactoring, the system intelligently interprets both your code and intent to generate updated, improved versions.

**Additional Capabilities**

* **@Knowledge Bases:** Mention integrated documentation or code sources for more accurate and context-sensitive responses.
* **Multi-Modal Input:** Interact using typed commands, voice instructions, or file uploads for maximum flexibility.

### Support & Resources

* **Education Access:** [app.codemate.ai/chat](https://app.codemate.ai/chat)
* **Docs & Guides:** [docs.codemate.ai](https://docs.codemate.ai/)
* **Support:** Reach out via the in-app help center or email: <support@codemate.ai>


# CodeMate for Education

CodeMate for Education offers a powerful, AI-assisted platform designed to elevate learning and teaching experiences in coding. Whether you're a student aiming to improve your skills or an educator managing multiple classrooms, getting started is quick and seamless.

#### Step-by-Step Onboarding

1. **Visit the Education Portal**\
   Head to [codemate.ai/edu](https://codemate.ai/edu) — this is your gateway to the academic version of CodeMate.
2. **Sign Up with Your Email**\
   Register using your institutional or personal email. You'll be onboarded as either a **Student** or **Teacher**, depending on your role.
3. **Access Your Personalized Dashboard**\
   After login, you'll be directed to a dashboard tailored to your role. Students get assignment tracking and practice tools, while teachers gain classroom control and performance insights.

### Feature Walkthrough

#### For Students

<figure><img src="/files/N9Ve5A7ATqmrLKKYuwIK" alt=""><figcaption></figcaption></figure>

* **Personalized Dashboard**\
  Track your longest streak, assignments submitted, and coding accuracy. All your pending tasks are highlighted for quick access.
* **Daily Activity Tracker**\
  Monitor your coding activity over time and stay consistent with your learning journey.
* **Pending Assignments List**\
  View assignment status, due dates, and submit directly from the dashboard. All instructions are AI-evaluated for fairness and clarity.
* **Leaderboards & Motivation**\
  Compete with classmates and climb the leaderboard through consistent, high-quality submissions.

***

#### For Teachers

<figure><img src="/files/Pgd2UAJYherLJ26EQcrA" alt=""><figcaption></figcaption></figure>

* **Smart Classroom Dashboard**\
  View total students, assignments created, and overall engagement at a glance.
* **Daily Submission Activity**\
  Instantly assess how active your classroom is and identify gaps in engagement.
* **Assignment Management**\
  Create and assign coding tasks, track individual and class-wise submissions, and manage deadlines effortlessly.
* **Invite & Manage Students**\
  Use the “Invite Members” or “New Classroom” feature to onboard students into your course or club sessions.
* Classroom Resources

<figure><img src="/files/9qULhCx19T1FaFnropYz" alt=""><figcaption></figcaption></figure>

Easily manage and share learning materials with your students.

* Upload notes, reference files, and content related to assignments.
* All resources stay organized under their respective assignments.
* Students can access materials directly while working on tasks.
* Simple, fast, and always accessible.

### Automated Assignment Assessment

Empower instructors with deep insights into student submissions.

* **Auto-Grading:** Instantly evaluates code submissions across key metrics like **Accuracy**, **Efficiency**, **Problem Solving**, **Logic Building**, and **Data Structures**.

<figure><img src="/files/tEyF35JluWeg4pStJib8" alt=""><figcaption></figcaption></figure>

* **Detailed Analytics:** Visual feedback with radial graphs for each parameter, helping students understand strengths and areas to improve.

<figure><img src="/files/RydhTnYZUfjlC3MoB1Wv" alt=""><figcaption></figcaption></figure>

* **Status Tracking:** Real-time status updates (Submitted, Graded, Pending Evaluation) with a clean, interactive dashboard.
* **Bulk Management:** Track all assignments with submission stats and deadlines in one view.

### Integrated AI Capabilities

* **CodeMate AI Chat**\
  Sure! Here’s a simpler, shorter version:

  CodeMate AI Chat helps students understand and debug their code by answering questions and explaining how the code works. It doesn’t write new code but guides learners to solve problems and learn better. This way, students improve their coding skills by getting clear explanations instead of just copying code.

<figure><img src="/files/OmgEq76XZior1MiTJIJl" alt=""><figcaption></figcaption></figure>

* **CodeMate Playground**\
  Both students and educators can use the AI coding assistant for real-time help, or debugging practice.

<figure><img src="/files/5fJ5TNdnduzjuauAOejt" alt=""><figcaption></figcaption></figure>

* **Learning Modules (Coming Soon)**\
  Access structured lessons and challenges powered by AI, ideal for self-paced or guided learning.

### Support & Resources

* **Education Access:** [codemate.ai/edu](https://codemate.ai/edu)
* **Docs & Guides:** [docs.codemate.ai](https://docs.codemate.ai/)
* **Support:** Reach out via the in-app help center or email: <support@codemate.ai>


# CodeMate Terminal

## Get Started with CodeTerm AI

#### Installation

Getting started with CodeTerm AI is quick and easy. Follow these simple steps to install the AI-powered terminal on your system:

1. **Download the Installer**\
   Visit the official download page at [cli.codemate.ai](https://cli.codemate.ai/) and select the installer for your operating system (currently available for **Linux** and **macOS**).
2. **Run the Installer**\
   Open the downloaded file and follow the on-screen instructions to complete the installation.
3. **Verify Installation**\
   Open your terminal and run:

```
codeterm --version
```

You should see the installed version number, confirming successful setup.

### Basic Usage

Once installed, CodeTerm AI brings intelligent natural language interaction and AI assistance right into your terminal.

* **Natural Language Commands**\
  Simply type your requests in plain English:

```
> find all large files in downloads
```

CodeTerm AI interprets and executes the matching terminal commands instantly.

* **AI Chat Interface**\
  Start an AI chat session by running:

```
> codeterm chat
```

Use this to generate code snippets, get explanations, or receive recommendations-all within your terminal environment.

***

### Feature Walkthrough

#### 1. Natural Language to Command Conversion

Convert plain English requests into precise terminal commands without memorizing complex syntax.

#### 2. AI-Powered Chat Interface

Engage in real-time conversations with an AI assistant for coding help, explanations, and optimization tips.

#### 3. Command Autocomplete

Benefit from smart autocomplete suggestions that speed up command entry and reduce errors.

#### 4. Privacy-Focused Design

CodeTerm AI operates locally on your machine, ensuring your code and commands remain fully private without any external data transmission.

#### 5. Cross-Platform Compatibility

Available on major Unix-based systems: Linux and macOS. Compatible with popular shells such as Bash and Zsh.

#### Support & Resources

* **Documentation:** [docs.codemate.ai](/codemate-terminal)
* **GitHub Repository:** [github.com/CodeMate-AI/codeterm](https://github.com/CodeMate-AI/codeterm)


# Platforms

CodeMate meets you where you work. Whether you're writing code in your editor, managing projects on the web, reviewing pull requests on GitHub, or learning in an academic environment there's a CodeMate experience built for that context.

***

### Visual Studio Code

Install the VS Code Extension for [CORA](https://marketplace.visualstudio.com/items?itemName=CodeMateAI.codemate-agent) and [C0](https://marketplace.visualstudio.com/items?itemName=AyushSinghal.Code-Mate)

The CodeMate extension for VS Code brings AI-powered coding assistance directly into your editor. Once installed, it connects automatically to the Toolbox subsystem running on your machine, giving you access to both C0 and CORA without leaving your development environment.

**What you can do from VS Code:**

* Get context-aware code suggestions, completions, and explanations grounded in your entire codebase not just the open file
* Use CORA to autonomously plan, write, test, and document code from a natural language prompt
* Debug, refactor, and generate test cases through a conversational interface in the editor sidebar
* Run code reviews and static analysis on demand

The extension requires Toolbox to be installed and the subsystem to be running. [Download Toolbox](https://app.codemate.ai/download) to get started.

***

### Web Application

Open the [Web App](https://codemate.ai/)

The CodeMate Web App gives you access to key CodeMate products from any browser no installation required beyond a CodeMate account. It's the home for Chat, Build, the Developer Dashboard, and account management.

**What you can do from the Web App:**

* Use [**Chat**](https://app.codemate.ai/chat) to ask questions grounded in your Jira tickets, project context, and knowledge bases
* Use [**Build**](https://build.codemateai.dev/build) to convert Figma files, prompts, or BRD documents into working web app prototypes
* View your [**Developer Dashboard**](https://app.codemate.ai/analytics) a customizable widget interface showing the metrics and data streams you care about
* Manage your subscription, account settings, and connected integrations

The Web App works alongside your desktop setup and is also the primary interface for CodeMate for Education.

***

### CodeMate for Education

CodeMate for Education extends the full product suite to students, educators, coding clubs, and institutions through the CodeMate Web App with offline support coming soon. It's designed to make industry-standard AI development tools accessible regardless of institutional resources or connectivity.

**Available through:** [CodeMate Web App](https://edu.codemate.ai/) offline integration coming soon.


# Enterprise

CodeMate for Enterprises gives you more customisations like:&#x20;

* Self-Hosted Knowledge Base&#x20;
* Single tenant deployment
* Improved context
* Pooled organization usage
* User management
* Role-based access control
* Optional finetuning on your codebase
* Configurable LLMs
* Dedicated Account Manager

Read more about the [Deployment options](/enterprise/deployment) we support. [Get in touch](https://cal.com/ayushsinghal/enterprise-cm) to book a meeting & discuss more.


# Deployment

CodeMate offers multiple deployment options to self-host your knowledge base so that your data is stored on your servers. The appropriate option for your organization depends on your goals and requirements, as well as the technical expertise and resources available. The following sections provide an overview of the available options and their associated investments and technical pre-requisites.

### Deployment types <a href="#deployment-types" id="deployment-types"></a>

Carefully consider your organization's needs and technical expertise when selecting a CodeMate Knowledge Base deployment method. The method you choose cannot be changed for a running instance, so make an informed decision. The available methods have different capabilities, and the following sections provide recommendations to help you choose.

### CodeMate Cloud <a href="#sourcegraph-cloud-https-sourcegraph-com-get-started-t-enterprise" id="sourcegraph-cloud-https-sourcegraph-com-get-started-t-enterprise"></a>

**For Enterprises looking for a managed Cloud solution.**

A cloud instance hosted and maintained by CodeMate.

### Machine Images <a href="#machine-images-machine-images-index-md" id="machine-images-machine-images-index-md"></a>

**For Enterprises looking for a self-hosted solution on the Cloud infrastructure of their choice.**

An option to run CodeMate Knowledge Base on your own infrastructure using pre-configured machine images.

Customized machine images allow you to spin up a preconfigured and customized CodeMate instance with just a few clicks, all in less than 10 minutes. Currently available in the following hosts:

### Install Script <a href="#install-script-single-node-script-md" id="install-script-single-node-script-md"></a>

CodeMate provides an install script that can deploy CodeMate instances to Linux-based virtual machines. This method is recommended for:

* On-premises deployments (your own infrastructure)
* Deployments to unsupported cloud providers (non-officially supported)

### Kubernetes <a href="#kubernetes-kubernetes-index-md" id="kubernetes-kubernetes-index-md"></a>

**For large Enterprises that require a multi-node, self-hosted solution.**

* **Kustomize** utilizes the built-in features of kubectl to provide maximum flexibility in configuring your deployment
* **Helm** offers a simpler deployment process but with less customization flexibility

We highly recommend deploying CodeMate on Kubernetes with Kustomize due to the flexibility it provides.

### Local machines <a href="#local-machines" id="local-machines"></a>

**For setting up non-production environments on local machines.**

* Docker Compose - Install CodeMate on Docker Compose
* Docker Single Container - Install CodeMate using a single Docker container

#### ARM / ARM64 support <a href="#arm-arm64-support" id="arm-arm64-support"></a>

Running CodeMate on ARM / ARM64 images is not supported for production deployments.


# Plans & Billing

Access the complete CodeMate ecosystem powering every step of your SDLC, from idea to deployment.

CodeMate offers a suite of three powerful developer products **CORA**, **BUILD**, and **C0** each with their own plans tailored to individuals, teams, and enterprises. Every plan is designed to be simple, transparent, and flexible so you only pay for what you need.

***

### CodeMate Max

> **Get unrestricted access to every CodeMate product — CORA, BUILD, and C0. Powered by top-tier models and unmetered requests. This is the complete system, without constraints.**

CodeMate Max is the ultimate plan for developers and teams who want the full CodeMate experience without any limitations. It bundles all three products into a single subscription at the best value.

| Billing Cycle | Price       |
| ------------- | ----------- |
| Monthly       | $250/month  |
| Annual        | $2,500/year |

> 💡 Annual plan saves you **$500** compared to paying monthly.

[Upgrade to CodeMate Max →](https://codemate.ai/pricing)

***

### CORA

CORA is CodeMate's Agentic Architect built for developers. It offers flexible short-cycle billing ideal for developers who want to try before committing to a longer plan.

#### Free Plan

The Free Plan is activated automatically when you sign up. It gives you access to core CORA features at no cost, forever.

* Access to basic LLM
* Access to CodeMate Chat
* Inline chat features inside VS Code
* Single file & local codebase reference for context-aware answers
* Jetbrains and VS Code Plugins

**Price: Free, always.**

***

#### CORA Pro

CORA Pro unlocks advanced capabilities for individual developers looking to supercharge their productivity. It extends limits and grants access to powerful features beyond the Free plan.

**Includes everything in Free, plus:**

* Advanced LLMs with faster response times
* Web browsing for accurate & current answers
* Knowledge Base storage
* Add content to Knowledge Base from GitHub Repositories & Web URLs
* Context-aware suggestions from chunks of code
* Debugging & refactoring features
* Access to CodeMate Assistant Preview
* Chat with content from any Web URL
* Access to beta features
* Priority support via a dedicated Discord Channel

| Billing Cycle | Price     |
| ------------- | --------- |
| Daily         | $1/day    |
| Weekly        | $5/week   |
| Monthly       | $20/month |

[Upgrade to CORA Pro →](https://codemate.ai/pricing)

***

#### CORA Max

CORA Max is the highest tier for CORA, offering the most powerful models, unmetered usage, and the complete CORA feature set for power users.

**Includes everything in CORA Pro, plus:**

* Top-tier LLM access
* Unmetered requests
* Highest priority support

| Billing Cycle | Price      |
| ------------- | ---------- |
| Daily         | $5/day     |
| Weekly        | $25/week   |
| Monthly       | $100/month |

[Upgrade to CORA Max →](https://codemate.ai/pricing)

***

### BUILD

BUILD is CodeMate's AI studio for generating, previewing, and deploying full-stack applications from a browser no local setup required.

#### Pro Plan

The Pro plan is built for individual developers who want access to BUILD's core feature set.

* 200 requests per day
* Unlimited image uploads and processing
* Figma-to-code conversion
* Document (PDF, DOC, TXT, DOCX )Support
* Instant deployment with shareable links
* Source code download capability

| Billing Cycle | Price     |
| ------------- | --------- |
| Monthly       | $20/month |
| Annual        | $200/year |

> 💡 Annual plan saves you **$40** compared to paying monthly.

***

#### Teams Plan

The Teams plan is designed for small to mid-sized development teams who want to bring BUILD into their collaborative workflows.

**Includes everything in Pro, plus:**

* 400 requests per day
* Voice Input Support
* Custom Domain
* Priority support through email & dedicated Discord Channel

| Billing Cycle | Price     |
| ------------- | --------- |
| Monthly       | $30/month |
| Annual        | $300/year |

> 💡 Annual plan saves you **$60** compared to paying monthly.

***

#### Enterprise Plan

The Enterprise plan is for large organizations with advanced security, compliance, and customization requirements.

**Includes everything in Teams, plus:**

* On-premises Deployment
* Custom fine-tuned models
* Pooled organization-wide usage
* Search & Chat with Documentation & Codebases
* Configurable LLMs
* Dedicated Account Manager

**Pricing: Contact us for a custom quote.**

[Reach out to our team →](mailto:contact@codemate.ai)

***

### C0

An AI coding assistant built into your IDE that understands and indexes your entire codebase.\
It helps you write, debug, review, and document code through natural conversation without leaving your editor.

#### Pro Plan

C0 Pro is for individual developers who want full access to C0's AI coding capabilities.

* Unlimited internet searches
* 10 cloud Knowledge Base storage
* Unlimited autocomplete
* Code Evaluation
* Pro Model Access

| Billing Cycle | Price     |
| ------------- | --------- |
| Monthly       | $10/month |
| Annual        | $100/year |

> 💡 Annual plan saves you **$20** compared to paying monthly.

***

#### Teams Plan

C0 Teams is designed for engineering teams who want to leverage C0 across their entire development workflow.

**Includes everything in Pro, plus:**

* Team-wide access management
* 25 cloud KB storage
* Priority support through email & dedicated Discord Channel

| Billing Cycle | Price     |
| ------------- | --------- |
| Monthly       | $15/month |
| Annual        | $150/year |

> 💡 Annual plan saves you **$30** compared to paying monthly.

***

#### Enterprise Plan

C0 Enterprise is built for large organizations that require advanced deployment options, security controls, and custom configurations.

**Includes everything in Teams, plus:**

* Dedicated Account Manager
* On-premises Deployment
* Custom fine-tuned models
* Search & Chat with Documentation & Codebases
* Rule based Code Review

**Pricing: Contact us for a custom quote.**

[Book a call with our team →](https://cal.com/ayushsinghal/enterprise-cm)

### Billing FAQs

**When am I charged?** You are charged at the start of each billing cycle daily, weekly, monthly, or annually depending on the plan you selected.

**Can I switch between billing cycles?** Yes. You can switch billing cycles (e.g., from monthly to annual) from the [Subscription page](https://codemate.ai/pricing). Changes take effect at the start of your next billing cycle.

**Can I upgrade or downgrade my plan?** Yes, plan upgrades and downgrades can be managed from your account's Subscription page. Upgrades take effect immediately; downgrades take effect at the end of the current billing cycle.

**Do annual plans auto-renew?** Yes, all plans auto-renew unless cancelled before the renewal date.

**What payment methods are accepted?** CodeMate accepts major credit and debit cards. Additional payment options may be available for Enterprise customers.

**How do I cancel my subscription?** You can cancel anytime from your account settings. You will retain access to paid features until the end of your current billing period.

**Is there a free trial on paid plans?** CORA's daily and weekly plans let you try Pro and Max with short-cycle commitments. For Enterprise plans  discuss with out team.

***

For a full feature comparison, visit [codemate.ai](https://codemate.ai).\
For Enterprise inquiries, [mail our team](mailto:contact@codemate.ai).


# Product Changelog

Read more about product changelog of:

### <img src="/files/oZJntcAqGO55WuLlzVXr" alt="" data-size="line"> [CodeMate VS Code Extension](/product-changelog/vs-code-extension-changelog)


# VS Code Extension Changelog

Complete changelog of CodeMate VS Code Extension.

### 🎉New! Read about our product updates in depth in our [Product Release Blog](https://blog.codemate.ai/category/product-updates/)&#x20;

### \[2.9.1]: 2024-05-12 <a href="#user-content-5b2.9.1-5d-3a-2024-05-12" id="user-content-5b2.9.1-5d-3a-2024-05-12"></a>

Added

* Test Cases generated from "Generate Test cases" command are now getting stored as a separate file in the root directory
* Bug fixes & improvements

### \[2.9.0]: 2024-04-19 <a href="#user-content-5b2.9.0-5d-3a-2024-04-19" id="user-content-5b2.9.0-5d-3a-2024-04-19"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Inline actions added for various actions
* Added Code Actions and Code Lenses for quick access to inline actions
* Added commands to generate code from inline comments triggered by keywords:
  * `// Codemate: <query>`: for asking Codemate Chat about something
  * `// Generate: <query>`: for generating code from the query
  * Press enter after typing the query to trigger the action
* Added option to view and edit the generated code from inline comments
* Added options to undo the applied inline edits and generations
* Added options to view diff of the inline edits or the generated code

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Minor bug fixes

<br>

### \[2.8.7]-\[2.8.8]: 2024-04-02 <a href="#user-content-5b2.8.7-5d-5b2.8.8-5d-3a-2024-04-02" id="user-content-5b2.8.7-5d-5b2.8.8-5d-3a-2024-04-02"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Added option to reset password/set new password for CodeMate account

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Minor bug fixes for incorrect plan showing in extension
* Minor bug fixes for incorrect caching

### \[2.8.5]-\[2.8.6]: 2024-03-22 <a href="#user-content-5b2.8.5-5d-5b2.8.6-5d-3a-2024-03-22" id="user-content-5b2.8.5-5d-5b2.8.6-5d-3a-2024-03-22"></a>

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Fixed an issue for showing incorrect plan in extension
* Fixed an issue where reminders for ending of plan were not showing correctly

### \[2.8.4]: 2024-03-19 <a href="#user-content-5b2.8.4-5d-3a-2024-03-19" id="user-content-5b2.8.4-5d-3a-2024-03-19"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Added option to delete individual projects from Knowledge Base

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Minor styling changes
* Fixed non-responsive styling in some cases

### \[2.8.3]: 2024-03-14 <a href="#user-content-5b2.8.3-5d-3a-2024-03-14" id="user-content-5b2.8.3-5d-3a-2024-03-14"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Optimized the knowledge base addition process (**`IMPORTANT`** We recommend that you resync all your projects to the knowledge base)
* Optimized internet chat mode to perform better
* Better context while referring to knowledge base

### \[2.8.1]-\[2.8.2]: 2024-02-20 <a href="#user-content-5b2.8.1-5d-5b2.8.2-5d-3a-2024-02-20" id="user-content-5b2.8.1-5d-5b2.8.2-5d-3a-2024-02-20"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Added function for Assistant to check whether a file exists in the active directory
* Added option to view User details in the Title bar of the extension sidebar

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Fixed a bug where GitHub login wasn't working properly
* Fixed some styling issues
* Fixed a bug where feedbacks were not working in Assistant view

### \[2.8.0]: 2024-02-17 <a href="#user-content-5b2.8.0-5d-3a-2024-02-17" id="user-content-5b2.8.0-5d-3a-2024-02-17"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* `CodeMate Assistant` is available to Pro and Teams plan users. *(Currently in Alpha)*
* Assistant Panel can be accessed from Chat view
* Added option to stop generating responses in Debug/Review/Optimize actions

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Minor bug fixes
* Styling fixes for webviews

<br>

### \[2.7.6]-\[2.7.7]: 2024-02-12 <a href="#user-content-5b2.7.6-5d-5b2.7.7-5d-3a-2024-02-12" id="user-content-5b2.7.6-5d-5b2.7.7-5d-3a-2024-02-12"></a>

#### Added <a href="#user-content-added" id="user-content-added"></a>

* Debug, Review and Optimize Panels updated for better viewing of responses
* Added quick access commands to editor context-menu
* Option to delete a thread
* Updated method to auto sync all projects on startup
* Added option to stop auto-sync for a particular local project
* Option to manually sync a project (local project, GitHub repo or a URL)

#### Fixes <a href="#user-content-fixes" id="user-content-fixes"></a>

* Fixed a bug where auto-sync wasn't properly syncing local files
* Fixed a bug where thread wasn't opening in the Chat Panel
* Fixed a bug where Debug and Review responses were not being returned in some cases

### \[2.7.4]-\[2.7.5]: 2024-02-07 <a href="#user-content-5b2.7.4-5d-5b2.7.5-5d-3a-2024-02-07" id="user-content-5b2.7.4-5d-5b2.7.5-5d-3a-2024-02-07"></a>

* Minor bug fixes

### \[2.7.3]-\[2.7.4]: 2024-02-05 <a href="#user-content-5b2.7.3-5d-5b2.7.4-5d-3a-2024-02-05" id="user-content-5b2.7.3-5d-5b2.7.4-5d-3a-2024-02-05"></a>

* Added threads in CodeMate Chat
* Added background auto-syncing of files of projects added in knowledge base
* Users can now view when the last sync was done for a project in the knowledge base
* Added past conversations in sidebar for quick access to last 3 conversations
* Updated Chat UI
* Fixed minor bugs

<br>

### \[2.6.9]-\[2.7.2]: 2024-01-30 <a href="#user-content-5b2.6.9-5d-5b2.7.2-5d-3a-2024-01-30" id="user-content-5b2.6.9-5d-5b2.7.2-5d-3a-2024-01-30"></a>

* Updated the UI for Files Panel
* Fixed a bug where the wrong project name was being set in case of multiple workspaces
* Added an option to view the individual files added to the knowledge base for a project
* Added option to select branches for GitHub repositories when adding to knowledge base

### \[2.6.8]: 2024-01-22 <a href="#user-content-5b2.6.8-5d-3a-2024-01-22" id="user-content-5b2.6.8-5d-3a-2024-01-22"></a>

* Changed the file input for attaching files to Chat
* Improved the UI for Chat
* Fixed a bug where plan type was showing Free plan

<br>

### \[2.6.6]-\[2.6.7]: 2024-01-15 <a href="#user-content-5b2.6.6-5d-5b2.6.7-5d-3a-2024-01-15" id="user-content-5b2.6.6-5d-5b2.6.7-5d-3a-2024-01-15"></a>

* Debug/Review/Optimize options now cache the results for faster access
* Auto clearing of cache and startup optimizations for the extension
* Improved Chat UI for feedback and save to history buttons
* Added more actions for code snippets in chat
* Previous messages can now be edited in chat to trigger new questions to the Assistant
* Fixed an issue where some folders and files were not visible while adding to knowledge base
* Fixed an issue with uploading files to knowledge base from multiple opened workspaces

### \[2.6.4]-\[2.6.5]: 2023-12-26 <a href="#user-content-5b2.6.4-5d-5b2.6.5-5d-3a-2023-12-26" id="user-content-5b2.6.4-5d-5b2.6.5-5d-3a-2023-12-26"></a>

* Added URL's referenced with web browsing in CodeMate Chat
* Added integration for Teams Plan
* Teams Plan users can view shared knowledge base content in CodeMate Chat

### \[2.6.2]- 2023-11-26 <a href="#user-content-5b2.6.2-5d-2023-11-26" id="user-content-5b2.6.2-5d-2023-11-26"></a>

* Fixed a bug where CodeMate Chat was not working
* Fixed an issue with Debug functionality
* Fixed an issue with GitHub repository loading
* Added more informative error messages

### \[2.6.1]- 2023-11-13 <a href="#user-content-5b2.6.1-5d-2023-11-13" id="user-content-5b2.6.1-5d-2023-11-13"></a>

* Added feature for inline chat with CodeMate AI in the active editor
* Fix issues in CodeMate Chat with Web Browsing
* Optmizations for faster start-up of CodeMate extension
* Minor bug fixes

### \[2.5.9] - \[2.6.0]- 2023-11-2 <a href="#user-content-5b2.5.9-5d-5b2.6.0-5d-2023-11-2" id="user-content-5b2.5.9-5d-5b2.6.0-5d-2023-11-2"></a>

* Improved responses of CodeMate Chat
* Added option to manage context for CodeMate Chat, users can check the context of the current conversation in the chat view
* Added option to clear and restore context for CodeMate Chat

### \[2.5.7] - \[2.5.8]- 2023-10-26 <a href="#user-content-5b2.5.7-5d-5b2.5.8-5d-2023-10-26" id="user-content-5b2.5.7-5d-5b2.5.8-5d-2023-10-26"></a>

* Minor bug fixes for CodeMate Chat and Knowledge Base Content

### \[2.5.6]- 2023-10-25 <a href="#user-content-5b2.5.6-5d-2023-10-25" id="user-content-5b2.5.6-5d-2023-10-25"></a>

* Added option to reference multiple knowledge base content(upto 2) by using '@' in the chat textbox
* Added option to open and view referenced files in current editor / browser in CodeMate Chat.
* Added option to clear the current chat history.
* Added notification for new releases of CodeMate.
* Added indicator in View Knowledge Base Content if nothing is added to the knowledge base.
* Added option to stop generating the current chat conversation in CodeMate Chat.
* Fixed a bug where clear knowledge base didn't clear the added websites in knowledge base.

### \[2.5.5]- 2023-10-15 <a href="#user-content-5b2.5.5-5d-2023-10-15" id="user-content-5b2.5.5-5d-2023-10-15"></a>

* Minor bug fixes

### \[2.5.4]- 2023-10-14 <a href="#user-content-5b2.5.4-5d-2023-10-14" id="user-content-5b2.5.4-5d-2023-10-14"></a>

* Added support for adding private git repositories to knowledge base(*for pro users only*)
* GitHub OAuth added for selecting owned repositories
* Added option for importing content from a website URL to knowledge base
* Commands & Shortcuts for knowledge base reference added in CodeMate Chat
* Added section for managing multiple actions related to knowledge base
* Minor UI updates and bug fixes

### \[2.5.3]- 2023-10-08 <a href="#user-content-5b2.5.3-5d-2023-10-08" id="user-content-5b2.5.3-5d-2023-10-08"></a>

* Fixed a bug where icons were not being rendered in extension sidebar and CodeMate chat
* Fixed a bug for scrolling view of CodeMate Chat
* Fixed a bug for exceeding token lengths for long conversations

### \[2.5.1]- 2023-09-29 <a href="#user-content-5b2.5.1-5d-2023-09-29" id="user-content-5b2.5.1-5d-2023-09-29"></a>

* Made CodeMate theme as per VS Code selected theme for better user experience
* Different pre-instructions for Code Review, Optimise and CodeMate chat
* Minor UI fixes
* KB now selects the open project by default
* Minor bug fixes and improvements

### \[2.5.0]- 2023-09-29 <a href="#user-content-5b2.5.0-5d-2023-09-29" id="user-content-5b2.5.0-5d-2023-09-29"></a>

* Conversational memory implemented in CodeMate chat for better context
* CodeMate chat now remembers the previous conversation and opens the last conversation by default
* URL parsing feature added in CodeMate chat (*currently only for pro users*) that allows users to send links to chat to answer queries
* Knowledge base limits modified for projects
* Pre-instruction option added in settings to allow users to send instructions before sending the actual query
* Fixed a bug where code blocks in CodeMate chat were not being highlighted correctly

### \[2.4.9]- 2023-09-25 <a href="#user-content-5b2.4.9-5d-2023-09-25" id="user-content-5b2.4.9-5d-2023-09-25"></a>

* Fixed bug where chat view was not persistent
* Project wise division of knowledge base
* Added option to reference a particular project from the knowledge base while using CodeMate chat
* Showing referenced files for a particular query in the chat view

### \[2.4.8]- 2023-09-19 <a href="#user-content-5b2.4.8-5d-2023-09-19" id="user-content-5b2.4.8-5d-2023-09-19"></a>

* Added option to delete chat history in CodeMate chat
* Fixed a bug where selected code from active editor was not being sent to CodeMate chat correctly
* Fixed a bug where suggestions and code from CodeMate chat was not being sent to selected text in active editor correctly
* Added option to select files which needs to be added to the knowledge base instead of whole codebase
* Added progress bar to show the progress of adding files to the knowledge base
* Fixed minor bugs

### \[2.4.7]- 2023-09-16 <a href="#user-content-5b2.4.7-5d-2023-09-16" id="user-content-5b2.4.7-5d-2023-09-16"></a>

* Added option to clear knowledge base from vector database in the Titlebar

### \[2.4.6]- 2023-09-14 <a href="#user-content-5b2.4.6-5d-2023-09-14" id="user-content-5b2.4.6-5d-2023-09-14"></a>

* Added auto-scroll in CodeMate chat

### \[2.4.5]- 2023-09-08 <a href="#user-content-5b2.4.5-5d-2023-09-08" id="user-content-5b2.4.5-5d-2023-09-08"></a>

* Removed auto scanning of codebase and Added option at the user end to start adding current open codebase to the knowledge base
* Added option to enter new line in CodeMate chat
* Added option to cancel Debug and Review code
* Fixed minor performance bugs
* Added option to select single line or multiple lines of code in CodeMate chat
* Restricted sending messages when response is printing in CodeMate chat


# Troubleshooting & FAQs

A reference for common questions and steps to resolve issues across CodeMate's products and platforms.

***

### VS Code Extension

If the CodeMate extension in VS Code isn't loading or working as expected, work through the following steps in order:

1. Reload or restart VS Code.
2. Ensure VS Code is updated to the latest version.
3. Check that the CodeMate extension is up to date.
4. Log out and log back in to the extension to reinitialize any stale sessions.
5. Reinstall the extension if the problem persists.
6. Check for conflicting extensions or background processes that may interfere with CodeMate's operations.
7. Verify whether the issue is isolated to a specific feature or affects the entire extension.

If none of these steps resolve the issue, raise a support ticket via our Discord Server with a full description of the problem.

***

### AI Agent (C0 & CORA)

The AI Agent is integrated directly within the CodeMate VS Code Extension. All AI-powered features code review, debugging, optimization, and autonomous coding are driven by this embedded agent.

<details>

<summary>The AI Agent isn't responding to my prompts.</summary>

Confirm that you're connected to the internet and logged into your CodeMate account. Restart VS Code and ensure both VS Code and the CodeMate extension are up to date. If the subsystem in Toolbox is not running, the agent will be unavailable open Toolbox and verify the subsystem status shows online before retrying.

</details>

<details>

<summary>The code generated doesn't match my expectations.</summary>

Try refining your input. The AI Agent responds more accurately to detailed prompts with clear structure and intent. Vague or one-line prompts will produce more generic output the more context you provide about your goal, the better the result.

</details>

<details>

<summary>C0 and CORA don't seem to be updating.</summary>

To get the latest versions, update C0 and CORA directly from the VS Code Extension Marketplace. It's good practice to check for updates periodically, especially after a VS Code extension update.

</details>

<details>

<summary>How can I improve the AI Agent's performance?</summary>

Keep the extension updated to the latest version, use specific and well-structured prompts, and provide in-app feedback where available. If responses feel slow, check your internet connection and ensure no other resource-intensive processes are competing with the Toolbox subsystem.

</details>

***

### Toolbox

<details>

<summary>The subsystem takes a long time to start.</summary>

This is expected behavior on first launch or after a system restart. The subsystem needs to allocate resources and initialize local modules before it's ready to accept IDE connections. Wait for the status indicator to show **online** before opening your IDE. For faster startup, enable Auto-start under **Settings → Subsystem → Auto-start** so the subsystem begins loading as soon as Toolbox opens.

</details>

<details>

<summary>Toolbox isn't connecting to my IDE.</summary>

If the subsystem is running but your IDE extension isn't connecting, install the CodeMate extensions directly from the IDE Marketplace rather than through Toolbox. Once installed from the marketplace, the extension will connect to the running subsystem automatically.

</details>

<details>

<summary>I'm seeing a warning at installation, or the installer isn't completing.</summary>

This can occur if network connectivity is interrupted during the download. Check your connection, re-download the installer from [app.codemate.ai/download](https://app.codemate.ai/download), and run it again. If the warning persists on macOS, go to **System Settings → Privacy & Security** and click "Open Anyway."

</details>

<details>

<summary>Can I customize Toolbox's appearance or behavior?</summary>

Yes. Toolbox supports theme customization and includes two display preferences: **Always on Top** keeps the Toolbox window above other applications, and **Always on Start** launches Toolbox automatically when your system starts. Both can be toggled from the Settings panel.

</details>

***

### FAQs

<details>

<summary>What is Build and Figma Mode?</summary>

Build is CodeMate's visual web app builder, accessible from the Web App. To use Figma Integration, click on Figma Mode, authenticate, and paste your Figma file link Build will analyze your design and scaffold a working web application from it.

</details>

<details>

<summary>What file types can I use as input in Build?</summary>

You can provide text files, Markdown, code, and images as input when working a project in Build.

</details>

<details>

<summary>Can I use custom domains with Build?</summary>

Yes, custom domain configuration is supported. Upgrade to the Pro version of Build to deploy your web app with a custom domain.

</details>

<details>

<summary>Does CORA have a browser agent?</summary>

Yes. CORA includes a browser agent capability that allows it to interact with web interfaces as part of an autonomous workflow useful for tasks that require reading from or acting on live web content.

</details>

<details>

<summary>Can I set rules for how the AI behaves in my project?</summary>

Yes. Rules can be configured at both the project level and globally within CORA. Project-specific rules govern how the agent writes code, structures responses, and follows team conventions. Rules are also configurable through the Web App.

</details>

<details>

<summary>What MCP servers does CodeMate support?</summary>

CORA supports a growing library of MCP servers. You can browse and connect servers from established MCP marketplaces.

</details>

<details>

<summary>What do I do if responses are slow?</summary>

Slow responses are most commonly caused by internet connection quality or server load during peak usage times. Check your connection first, then retry. If slowdowns are persistent, try restarting the Toolbox subsystem and ensuring no large background processes are competing for resources.

</details>

The complete FAQ is available at [codemate.ai](http://codemate.ai). If the issue persists, you can reach us at <contact@codemate.ai>.


# Policies

At CodeMate, we are committed to maintaining transparency, trust, and integrity in how we operate and interact with our users. This page serves as a central hub for all our official policy documents and guidelines. Whether you're a student, educator, developer, or organization, these policies help clarify your rights, responsibilities, and our practices.

#### Navigate to:

* **Privacy Policy** – How we collect, use, and protect your data.
* **Terms of Service** – Your rights and obligations while using CodeMate.
* **Refund Policy** – Guidelines on subscription cancellation and refunds.
* **Fair Usage Policy** – Ensuring responsible and equitable use of our platform.
* **Community Guidelines** – Maintaining a respectful and collaborative environment.

Each section offers detailed insights to help you understand and use CodeMate with confidence.


# Terms of Service

Last updated March 22, 2025

## AGREEMENT TO OUR LEGAL TERMS

We are CodeMate Inc, doing business as CodeMate ('Company', 'we', 'us', or 'our'), a company registered in United States at 8 The Green STE R, Dover, Delaware- 19901.&#x20;

We operate the website <https://www.codemate.ai/> (the 'Site'), as well as any other related products and services that refer or link to these legal terms (the 'Legal Terms') (collectively, the Services').

CodeMate is an AI-powered coding assistant that writes, fixes, and maintains your code. It offers a wide range of features such as error fixing, code review, code optimization, generating test cases etc. With our AI-driven proprietary technology, CodeMate understands about your entire codebase or product documentation and hence can detect logical, syntax, and runtime errors and fix them just like autocorrect for your code. It can also reduce hours of manual debugging into minutes with auto-suggested changes, thereby assisting you to write accurate code. CodeMate is designed to help programmers of all skill levels to identify and fix errors in their code quickly and easily. It provides more accurate and specific suggestions for improvement, resulting in higher quality code. CodeMate connects seamlessly with codehosts like GitHub, GitLab and IDEs like VS Code and JetBrains through its command line tool. Once connected, CodeMate acts as your personal AI coding assistant, equipped with a comprehensive understanding of the following three crucial elements: 1. Your entire codebase 2. Vast knowledge of open source code or your organisation's Knowledge base 3.Extensive training data for code understanding and problem-solving

You can contact us by phone at +91 8766330253, email at <contact@codemate.ai>, or by mail to 8 The Green STE R, Dover, Delaware- 19901..

These Legal Terms constitute a legally binding agreement made between you, whether personally or on behalf of an entity ('you'), and CodeMate Inc, concerning your access to and use of the Services. You agree that by accessing the Services, you have read, understood, and agreed to be bound by all of these Legal Terms. IF YOU DO NOT AGREE WITH ALL OF THESE LEGAL TERMS, THEN YOU ARE EXPRESSLY PROHIBITED FROM USING THE SERVICES AND YOU MUST DISCONTINUE USE IMMEDIATELY.

Supplemental terms and conditions or documents that may be posted on the Services from time to time are hereby expressly incorporated herein by reference. We reserve the right, in our sole discretion, to make changes or modifications to these Legal Terms from time to time. We will alert you about any changes by updating the 'Last updated' date of these Legal Terms, and you waive any right to receive specific notice of each such change. It is your responsibility to periodically review these Legal Terms to stay informed of updates. You will be subject to, and will be deemed to have been made aware of and to have accepted, the changes in any revised Legal Terms by your continued use of the Services after the date such revised Legal Terms are posted.

All users who are minors in the jurisdiction in which they reside (generally under the age of 18) must have the permission of, and be directly supervised by, their parent or guardian to use the

Services. If you are a minor, you must have your parent or guardian read and agree to these Legal Terms prior to you using the Services.

We recommend that you print a copy of these Legal Terms for your records.

## TABLE OF CONTENTS

1\.    [ OUR SERVICES](#1.-our-services)

2\.    [ INTELLECTUAL PROPERTY RIGHTS](#2.-intellectual-property-rights)

3\.    [ USER REPRESENTATIONS](#3.-user-representations)

4\.    [ USER REGISTRATION](#4.-user-registration)

5\.   [  PURCHASES AND PAYMENT](#5.-purchases-and-payment)

6\.     [CANCELLATION](#6.-cancellation)

7\.    [ SOFTWARE](#7.-software)

8\.    [ PROHIBITED ACTIVITIES](#8.-prohibited-activities)

9\.    [ USER GENERATED CONTRIBUTIONS](#9.-user-generated-contributions)

10\. [ CONTRIBUTION LICENCE](#10.-contribution-licence)

11\. [ GUIDELINES FOR REVIEWS](#11.-guidelines-for-reviews)

12\. [ SOCIAL MEDIA](#12.-social-media)

13\. [ THIRD-PARTY WEBSITES AND CONTENT](#13.-third-party-websites-and-content)

[14.  SERVICES MANAGEMENT](#14.-services-management)

[15.  PRIVACY POLICY](/policies/privacy-policy)

[16.  TERM AND TERMINATION](#16.-term-and-termination)

[17.  MODIFICATIONS AND INTERRUPTIONS](#17.-modifications-and-interruptions)

[18.  GOVERNING LAW](#18.-governing-law)

[19.  DISPUTE RESOLUTION](#19.-dispute-resolution)

[20.  CORRECTIONS](#20.-corrections)

[21.  DISCLAIMER](#21.-disclaimer)

[22.  LIMITATIONS OF LIABILITY](#22.-limitations-of-liability)

[23.  INDEMNIFICATION](#23.-indemnification)

[24.  USER DATA](#24.-user-data)

[25.  ELECTRONIC COMMUNICATIONS, TRANSACTIONS, AND SIGNATURES](#25.-electronic-communications-transactions-and-signatures)

[26.  CALIFORNIA USERS AND RESIDENTS](#26.-california-users-and-residents)

[27.  MISCELLANEOUS](#27.-miscellaneous)

[28.  CONTACT US](#28.-contact-us)

## 1.  OUR SERVICES

The information provided when using the Services is not intended for distribution to or use by any person or entity in any jurisdiction or country where such distribution or use would be contrary to law or regulation or which would subject us to any registration requirement within such jurisdiction or country. Accordingly, those persons who choose to access the Services from other locations do so on their own initiative and are solely responsible for compliance with local laws, if and to the extent local laws are applicable.

The Services are not tailored to comply with industry-specific regulations (Health Insurance

Portability and Accountability Act (HIPAA), Federal Information Security Management Act (FISMA), etc.), so if your interactions would be subjected to such laws, you may not use the Services. You may not use the Services in a way that would violate the Gramm-Leach-Bliley Act (GLBA).

## 2.  INTELLECTUAL PROPERTY RIGHTS

### Our intellectual property

We are the owner or the licensee of all intellectual property rights in our Services, including all source code, databases, functionality, software, website designs, audio, video, text, photographs, and graphics in the Services (collectively, the 'Content'), as well as the trademarks, service marks, and logos contained therein (the 'Marks').

Our Content and Marks are protected by copyright and trademark laws (and various other intellectual property rights and unfair competition laws) and treaties in the United States and around the world.

The Content and Marks are provided in or through the Services 'AS IS' for your personal, non-commercial use or internal business purpose only.

### Your use of our Services

Subject to your compliance with these Legal Terms, we grant you a non-exclusive, non-transferable, revocable license to:

You are allowed to:

* Access and use the Services.
* View, download, modify, and incorporate any output generated by the Services (e.g., code, documentation, or suggestions) into your software projects. This includes commercial purposes such as selling or distributing software products that include or are based on such output.

Except as expressly permitted by these Terms or in a separate agreement, you may not:

* Repackage or resell access to the Services or substantial portions of the Content itself as a product or service;
* Represent our output as human-generated without attribution if required under law or regulation.\
  All rights not expressly granted are reserved.&#x20;

For enterprise licensing or use cases involving redistribution of our Services or significant content at scale, please contact <contact@codemate.ai>.

Any breach of these Intellectual Property Rights will constitute a material breach of our Legal Terms and your right to use our Services will terminate immediately.

### Your submissions

Please review this section and the ['PROHIBITED ACTIVITIES'](#8.-prohibited-activities) section carefully prior to using our Services to understand the (a) rights you give us and (b) obligations you have when you post or upload any content through the Services.

Submissions: By directly sending us any question, comment, suggestion, idea, feedback, or other information about the Services ('Submissions'), you agree to assign to us all intellectual property rights in such Submission. You agree that we shall own this Submission and be entitled to its unrestricted use and dissemination for any lawful purpose, commercial or otherwise, without acknowledgment or compensation to you.

You are responsible for what you post or upload: By sending us Submissions through any part of the Services you:

■    confirm that you have read and agree with our[ 'PROHIBITED ACTIVITIES' ](#8.-prohibited-activities)and will not post, send, publish, upload, or transmit through the Services any Submission that is illegal, harassing, hateful, harmful, defamatory, obscene, bullying, abusive, discriminatory, threatening to any person or group, sexually explicit, false, inaccurate, deceitful, or misleading;

■    to the extent permissible by applicable law, waive any and all moral rights to any such Submission;

■    warrant that any such Submission are original to you or that you have the necessary rights and licences to submit such Submissions and that you have full authority to grant us the above-mentioned rights in relation to your Submissions; and

■    warrant and represent that your Submissions do not constitute confidential information.

You are solely responsible for your Submissions and you expressly agree to reimburse us for any and all losses that we may suffer because of your breach of (a) this section, (b) any third party’s intellectual property rights, or (c) applicable law.

## 3.  USER REPRESENTATIONS

By using the Services, you represent and warrant that: (1) all registration information you submit will be true, accurate, current, and complete; (2) you will maintain the accuracy of such information and promptly update such registration information as necessary; (3) you have the legal capacity and you agree to comply with these Legal Terms; (4) you are not a minor in the jurisdiction in which you reside, or if a minor, you have received parental permission to use the Services; (5) you will not access the Services through automated or non-human means, whether through a bot, script or otherwise; (6) you will not use the Services for any illegal or unauthorised purpose; and (7) your use of the Services will not violate any applicable law or regulation.

If you provide any information that is untrue, inaccurate, not current, or incomplete, we have the right to suspend or terminate your account and refuse any and all current or future use of the Services (or any portion thereof).

## 4.  USER REGISTRATION

You may be required to register to use the Services. You agree to keep your password confidential and will be responsible for all use of your account and password. We reserve the right to remove, reclaim, or change a username you select if we determine, in our sole discretion, that such username is inappropriate, obscene, or otherwise objectionable.

## 5.  PURCHASES AND PAYMENT

We accept the following forms of payment:

\-   Visa

\-   Mastercard

\-   American Express

\-   Discover

\-   Rupay

You agree to provide current, complete, and accurate purchase and account information for all purchases made via the Services. You further agree to promptly update account and payment information, including email address, payment method, and payment card expiration date, so that we can complete your transactions and contact you as needed. Sales tax will be added to the price of purchases as deemed required by us. We may change prices at any time. All payments shall be in Rupee or dollars.

You agree to pay all charges at the prices then in effect for your purchases and any applicable shipping fees, and you authorise us to charge your chosen payment provider for any such amounts upon placing your order. If your order is subject to recurring charges, then you consent to our charging your payment method on a recurring basis without requiring your prior approval for each recurring charge, until such time as you cancel the applicable order. We reserve the right to correct any errors or mistakes in pricing, even if we have already requested or received payment.

We reserve the right to refuse any order placed through the Services. We may, in our sole discretion, limit or cancel quantities purchased per person, per household, or per order. These restrictions may include orders placed by or under the same customer account, the same payment method, and/or orders that use the same billing or shipping address. We reserve the right to limit or prohibit orders that, in our sole judgement, appear to be placed by dealers, resellers, or distributors.

## 6.  CANCELLATION

You can cancel your subscription at any time within 14 days by contacting us using the contact information provided below.

If you are unsatisfied with our Services, please email us at <contact@codemate.ai>&#x20;

## 7.  SOFTWARE

We may include software for use in connection with our Services. If such software is accompanied by an end user licence agreement ('EULA'), the terms of the EULA will govern your use of the software. If such software is not accompanied by a EULA, then we grant to you a non-exclusive, revocable, personal, and non-transferable licence to use such software solely in connection with our services and in accordance with these Legal Terms. Any software and any related documentation is provided 'AS IS' without warranty of any kind, either express or implied, including, without limitation, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. You accept any and all risk arising out of use or performance of any software. You may not reproduce or redistribute any software except in accordance with the EULA or these Legal Terms.

## 8.  PROHIBITED ACTIVITIES

You may not access or use the Services for any purpose other than that for which we make the Services available. The Services may not be used in connection with any commercial endeavours except those that are specifically endorsed or approved by us.

As a user of the Services, you agree not to:

Systematically retrieve data or other content from the Services to create or compile, directly or indirectly, a collection, compilation, database, or directory without written permission from us.

■    Trick, defraud, or mislead us and other users, especially in any attempt to learn sensitive account information such as user passwords.

■    Circumvent, disable, or otherwise interfere with security-related features of the Services, including features that prevent or restrict the use or copying of any Content or enforce limitations on the use of the Services and/or the Content contained therein.

&#x20;     ■    Disparage, tarnish, or otherwise harm, in our opinion, us and/or the Services.

■ Use any information obtained from the Services in order to harass, abuse, or harm another person.

&#x20;     ■    Make improper use of our support services or submit false reports of abuse or misconduct.

&#x20;     ■    Use the Services in a manner inconsistent with any applicable laws or regulations.

&#x20;     ■    Engage in unauthorised framing of or linking to the Services.

■    Upload or transmit (or attempt to upload or to transmit) viruses, Trojan horses, or other material, including excessive use of capital letters and spamming (continuous posting of repetitive text), that interferes with any party’s uninterrupted use and enjoyment of the Services or modifies, impairs, disrupts, alters, or interferes with the use, features, functions, operation, or maintenance of the Services.

■    Engage in any automated use of the system, such as using scripts to send comments or messages, or using any data mining, robots, or similar data gathering and extraction tools.

&#x20;     ■    Delete the copyright or other proprietary rights notice from any Content.

&#x20;     ■    Attempt to impersonate another user or person or use the username of another user.

■    Upload or transmit (or attempt to upload or to transmit) any material that acts as a passive or active information collection or transmission mechanism, including without limitation, clear graphics interchange formats ('gifs'), 1×1 pixels, web bugs, cookies, or other similar devices (sometimes referred to as 'spyware' or 'passive collection mechanisms' or 'pcms').

■    Interfere with, disrupt, or create an undue burden on the Services or the networks or services connected to the Services.

■    Harass, annoy, intimidate, or threaten any of our employees or agents engaged in providing any portion of the Services to you.

■    Attempt to bypass any measures of the Services designed to prevent or restrict access to the Services, or any portion of the Services.

■    Copy or adapt the Services' software, including but not limited to Flash, PHP, HTML, JavaScript, or other code.

Except as permitted by applicable law, decipher, decompile, disassemble, or reverse engineer any of the software comprising or in any way making up a part of the Services.

■    Except as may be the result of standard search engine or Internet browser usage, use, launch, develop, or distribute any automated system, including without limitation, any spider, robot, cheat utility, scraper, or offline reader that accesses the Services, or use or launch any unauthorised script or other software.

&#x20;     ■    Use a buying agent or purchasing agent to make purchases on the Services.

■    Make any unauthorised use of the Services, including collecting usernames and/or email addresses of users by electronic or other means for the purpose of sending unsolicited email, or creating user accounts by automated means or under false pretences.

■    Use the Services as part of any effort to compete with us or otherwise use the Services and/or the Content for any revenue-generating endeavour or commercial enterprise.

&#x20;     ■    Sell or otherwise transfer your profile.

## 9.  USER GENERATED CONTRIBUTIONS

The Services does not offer users to submit or post content. We may provide you with the opportunity to create, submit, post, display, transmit, perform, publish, distribute, or broadcast content and materials to us or on the Services, including but not limited to text, writings, video, audio, photographs, graphics, comments, suggestions, or personal information or other material (collectively, 'Contributions'). Contributions may be viewable by other users of the Services and through third-party websites. When you create or make available any Contributions, you thereby represent and warrant that:

■    The creation, distribution, transmission, public display, or performance, and the accessing, downloading, or copying of your Contributions do not and will not infringe the proprietary rights, including but not limited to the copyright, patent, trademark, trade secret, or moral rights of any third party.

■    You are the creator and owner of or have the necessary licences, rights, consents, releases, and permissions to use and to authorise us, the Services, and other users of the Services to use your Contributions in any manner contemplated by the Services and these Legal Terms.

You have the written consent, release, and/or permission of each and every identifiable individual person in your Contributions to use the name or likeness of each and every such identifiable individual person to enable inclusion and use of your Contributions in any manner contemplated by the Services and these Legal Terms.

&#x20;     ■    Your Contributions are not false, inaccurate, or misleading.

■    Your Contributions are not unsolicited or unauthorised advertising, promotional materials, pyramid schemes, chain letters, spam, mass mailings, or other forms of solicitation.

■    Your Contributions are not obscene, lewd, lascivious, filthy, violent, harassing, libellous, slanderous, or otherwise objectionable (as determined by us).

&#x20;     ■    Your Contributions do not ridicule, mock, disparage, intimidate, or abuse anyone.

■    Your Contributions are not used to harass or threaten (in the legal sense of those terms) any other person and to promote violence against a specific person or class of people.

&#x20;     ■    Your Contributions do not violate any applicable law, regulation, or rule.

&#x20;     ■    Your Contributions do not violate the privacy or publicity rights of any third party.

■    Your Contributions do not violate any applicable law concerning child pornography, or otherwise intended to protect the health or well-being of minors.

■    Your Contributions do not include any offensive comments that are connected to race, national origin, gender, sexual preference, or physical handicap.

■    Your Contributions do not otherwise violate, or link to material that violates, any provision of these Legal Terms, or any applicable law or regulation.

Any use of the Services in violation of the foregoing violates these Legal Terms and may result in, among other things, termination or suspension of your rights to use the Services.

## 10.  CONTRIBUTION LICENCE

You and Services agree that we may access, store, process, and use any information and personal data that you provide and your choices (including settings).

By submitting suggestions or other feedback regarding the Services, you agree that we can use and share such feedback for any purpose without compensation to you.

We do not assert any ownership over your Contributions. You retain full ownership of all of your

Contributions and any intellectual property rights or other proprietary rights associated with your Contributions. We are not liable for any statements or representations in your Contributions provided by you in any area on the Services. You are solely responsible for your Contributions to the Services and you expressly agree to exonerate us from any and all responsibility and to refrain from any legal action against us regarding your Contributions.

## 11.  GUIDELINES FOR REVIEWS

We may provide you areas on the Services to leave reviews or ratings. When posting a review, you must comply with the following criteria: (1) you should have firsthand experience with the person/entity being reviewed; (2) your reviews should not contain offensive profanity, or abusive, racist, offensive, or hateful language; (3) your reviews should not contain discriminatory references based on religion, race, gender, national origin, age, marital status, sexual orientation, or disability; (4) your reviews should not contain references to illegal activity; (5) you should not be affiliated with competitors if posting negative reviews; (6) you should not make any conclusions as to the legality of conduct; (7) you may not post any false or misleading statements; and (8) you may not organise a campaign encouraging others to post reviews, whether positive or negative.

We may accept, reject, or remove reviews in our sole discretion. We have absolutely no obligation to screen reviews or to delete reviews, even if anyone considers reviews objectionable or inaccurate. Reviews are not endorsed by us, and do not necessarily represent our opinions or the views of any of our affiliates or partners. We do not assume liability for any review or for any claims, liabilities, or losses resulting from any review. By posting a review, you hereby grant to us a perpetual, non-exclusive, worldwide, royalty-free, fully paid, assignable, and sublicensable right and licence to reproduce, modify, translate, transmit by any means, display, perform, and/or distribute all content relating to review.

## 12.  SOCIAL MEDIA

As part of the functionality of the Services, you may link your account with online accounts you have with third-party service providers (each such account, a 'Third-Party Account') by either:

(1) providing your Third-Party Account login information through the Services; or (2) allowing us to access your Third-Party Account, as is permitted under the applicable terms and conditions that govern your use of each Third-Party Account. You represent and warrant that you are entitled to disclose your Third-Party Account login information to us and/or grant us access to your Third-Party Account, without breach by you of any of the terms and conditions that govern your use of the applicable Third-Party Account, and without obligating us to pay any fees or making us subject to any usage limitations imposed by the third-party service provider of the

Third-Party Account. By granting us access to any Third-Party Accounts, you understand that (1) we may access, make available, and store (if applicable) any content that you have provided to and stored in your Third-Party Account (the 'Social Network Content') so that it is available on and through the Services via your account, including without limitation any friend lists and (2) we may submit to and receive from your Third-Party Account additional information to the extent you are notified when you link your account with the Third-Party Account. Depending on the

Third-Party Accounts you choose and subject to the privacy settings that you have set in such

Third-Party Accounts, personally identifiable information that you post to your Third-Party

Accounts may be available on and through your account on the Services. Please note that if a

Third-Party Account or associated service becomes unavailable or our access to such

Third-Party Account is terminated by the third-party service provider, then Social Network Content may no longer be available on and through the Services. You will have the ability to disable the connection between your account on the Services and your Third-Party Accounts at any time. PLEASE NOTE THAT YOUR RELATIONSHIP WITH THE THIRD-PARTY SERVICE PROVIDERS ASSOCIATED WITH YOUR THIRD-PARTY ACCOUNTS IS GOVERNED SOLELY BY YOUR AGREEMENT(S) WITH SUCH THIRD-PARTY SERVICE PROVIDERS. We

make no effort to review any Social Network Content for any purpose, including but not limited to, for accuracy, legality, or non-infringement, and we are not responsible for any Social Network Content. You acknowledge and agree that we may access your email address book associated with a Third-Party Account and your contacts list stored on your mobile device or tablet computer solely for purposes of identifying and informing you of those contacts who have also registered to use the Services. You can deactivate the connection between the Services and your Third-Party Account by contacting us using the contact information below or through your account settings (if applicable). We will attempt to delete any information stored on our servers that was obtained through such Third-Party Account, except the username and profile picture that become associated with your account.

## 13.  THIRD-PARTY WEBSITES AND CONTENT

The Services may contain (or you may be sent via the Site) links to other websites ('Third-Party Websites') as well as articles, photographs, text, graphics, pictures, designs, music, sound, video, information, applications, software, and other content or items belonging to or originating from third parties ('Third-Party Content'). Such Third-Party Websites and Third-Party Content are not investigated, monitored, or checked for accuracy, appropriateness, or completeness by us, and we are not responsible for any Third-Party Websites accessed through the Services or any Third-Party Content posted on, available through, or installed from the Services, including the content, accuracy, offensiveness, opinions, reliability, privacy practices, or other policies of or contained in the Third-Party Websites or the Third-Party Content. Inclusion of, linking to, or permitting the use or installation of any Third-Party Websites or any Third-Party Content does not imply approval or endorsement thereof by us. If you decide to leave the Services and access the Third-Party Websites or to use or install any Third-Party Content, you do so at your own risk, and you should be aware these Legal Terms no longer govern. You should review the applicable terms and policies, including privacy and data gathering practices, of any website to which you navigate from the Services or relating to any applications you use or install from the Services. Any purchases you make through Third-Party Websites will be through other websites and from other companies, and we take no responsibility whatsoever in relation to such purchases which are exclusively between you and the applicable third party. You agree and acknowledge that we do not endorse the products or services offered on Third-Party Websites and you shall hold us blameless from any harm caused by your purchase of such products or services. Additionally, you shall hold us blameless from any losses sustained by you or harm caused to you relating to or resulting in any way from any Third-Party Content or any contact with Third-Party Websites.

## 14.  SERVICES MANAGEMENT

We reserve the right, but not the obligation, to: (1) monitor the Services for violations of these Legal Terms; (2) take appropriate legal action against anyone who, in our sole discretion, violates the law or these Legal Terms, including without limitation, reporting such user to law enforcement authorities; (3) in our sole discretion and without limitation, refuse, restrict access to, limit the availability of, or disable (to the extent technologically feasible) any of your Contributions or any portion thereof; (4) in our sole discretion and without limitation, notice, or liability, to remove from the Services or otherwise disable all files and content that are excessive in size or are in any way burdensome to our systems; and (5) otherwise manage the Services in a manner designed to protect our rights and property and to facilitate the proper functioning of the Services.

## 15.  PRIVACY POLICY

We care about data privacy and security. By using the Services, you agree to be bound by our Privacy Policy posted on the Services, which is incorporated into these Legal Terms. Please be advised the Services are hosted in United States. If you access the Services from any other region of the world with laws or other requirements governing personal data collection, use, or disclosure that differ from applicable laws in United States, then through your continued use of the Services, you are transferring your data to United States, and you expressly consent to have your data transferred to and processed in United States.

## 16.  TERM AND TERMINATION

These Legal Terms shall remain in full force and effect while you use the Services. WITHOUT

LIMITING ANY OTHER PROVISION OF THESE LEGAL TERMS, WE RESERVE THE RIGHT

TO, IN OUR SOLE DISCRETION AND WITHOUT NOTICE OR LIABILITY, DENY ACCESS TO

AND USE OF THE SERVICES (INCLUDING BLOCKING CERTAIN IP ADDRESSES), TO ANY

PERSON FOR ANY REASON OR FOR NO REASON, INCLUDING WITHOUT LIMITATION

FOR BREACH OF ANY REPRESENTATION, WARRANTY, OR COVENANT CONTAINED IN

THESE LEGAL TERMS OR OF ANY APPLICABLE LAW OR REGULATION. WE MAY

TERMINATE YOUR USE OR PARTICIPATION IN THE SERVICES OR DELETE YOUR ACCOUNT AND ANY CONTENT OR INFORMATION THAT YOU POSTED AT ANY TIME, WITHOUT WARNING, IN OUR SOLE DISCRETION.

If we terminate or suspend your account for any reason, you are prohibited from registering and creating a new account under your name, a fake or borrowed name, or the name of any third party, even if you may be acting on behalf of the third party. In addition to terminating or suspending your account, we reserve the right to take appropriate legal action, including without limitation pursuing civil, criminal, and injunctive redress.

## 17.  MODIFICATIONS AND INTERRUPTIONS

We reserve the right to change, modify, or remove the contents of the Services at any time or for any reason at our sole discretion without notice. However, we have no obligation to update any information on our Services. We will not be liable to you or any third party for any modification, price change, suspension, or discontinuance of the Services.

We cannot guarantee the Services will be available at all times. We may experience hardware, software, or other problems or need to perform maintenance related to the Services, resulting in interruptions, delays, or errors. We reserve the right to change, revise, update, suspend, discontinue, or otherwise modify the Services at any time or for any reason without notice to you. You agree that we have no liability whatsoever for any loss, damage, or inconvenience caused by your inability to access or use the Services during any downtime or discontinuance of the Services. Nothing in these Legal Terms will be construed to obligate us to maintain and support the Services or to supply any corrections, updates, or releases in connection therewith.

## 18.  GOVERNING LAW

These Legal Terms shall be governed by and defined following the laws of US. CodeMate Inc and yourself irrevocably consent that the courts of United States shall have exclusive jurisdiction to resolve any dispute which may arise in connection with these Legal Terms.

## 19.  DISPUTE RESOLUTION

You agree to irrevocably submit all disputes related to these Legal Terms or the legal relationship established by these Legal Terms to the jurisdiction of the United States courts. CodeMate INC shall also maintain the right to bring proceedings as to the substance of the matter in the courts of the country where you reside or, if these Legal Terms are entered into in the course of your trade or profession, the state of your principal place of business.

## 20.  CORRECTIONS

There may be information on the Services that contains typographical errors, inaccuracies, or omissions, including descriptions, pricing, availability, and various other information. We reserve the right to correct any errors, inaccuracies, or omissions and to change or update the information on the Services at any time, without prior notice.

## 21.  DISCLAIMER

THE SERVICES ARE PROVIDED ON AN AS-IS AND AS-AVAILABLE BASIS. YOU AGREE

THAT YOUR USE OF THE SERVICES WILL BE AT YOUR SOLE RISK. TO THE FULLEST

EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,

IN CONNECTION WITH THE SERVICES AND YOUR USE THEREOF, INCLUDING, WITHOUT

LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A

PARTICULAR PURPOSE, AND NON-INFRINGEMENT. WE MAKE NO WARRANTIES OR

REPRESENTATIONS ABOUT THE ACCURACY OR COMPLETENESS OF THE SERVICES'

CONTENT OR THE CONTENT OF ANY WEBSITES OR MOBILE APPLICATIONS LINKED TO

THE SERVICES AND WE WILL ASSUME NO LIABILITY OR RESPONSIBILITY FOR ANY (1)

ERRORS, MISTAKES, OR INACCURACIES OF CONTENT AND MATERIALS, (2) PERSONAL

INJURY OR PROPERTY DAMAGE, OF ANY NATURE WHATSOEVER, RESULTING FROM

YOUR ACCESS TO AND USE OF THE SERVICES, (3) ANY UNAUTHORISED ACCESS TO

OR USE OF OUR SECURE SERVERS AND/OR ANY AND ALL PERSONAL INFORMATION

AND/OR FINANCIAL INFORMATION STORED THEREIN, (4) ANY INTERRUPTION OR

CESSATION OF TRANSMISSION TO OR FROM THE SERVICES, (5) ANY BUGS, VIRUSES,

TROJAN HORSES, OR THE LIKE WHICH MAY BE TRANSMITTED TO OR THROUGH THE

SERVICES BY ANY THIRD PARTY, AND/OR (6) ANY ERRORS OR OMISSIONS IN ANY

CONTENT AND MATERIALS OR FOR ANY LOSS OR DAMAGE OF ANY KIND INCURRED

AS A RESULT OF THE USE OF ANY CONTENT POSTED, TRANSMITTED, OR OTHERWISE

MADE AVAILABLE VIA THE SERVICES. WE DO NOT WARRANT, ENDORSE, GUARANTEE,

OR ASSUME RESPONSIBILITY FOR ANY PRODUCT OR SERVICE ADVERTISED OR

OFFERED BY A THIRD PARTY THROUGH THE SERVICES, ANY HYPERLINKED WEBSITE,

OR ANY WEBSITE OR MOBILE APPLICATION FEATURED IN ANY BANNER OR OTHER ADVERTISING, AND WE WILL NOT BE A PARTY TO OR IN ANY WAY BE RESPONSIBLE

FOR MONITORING ANY TRANSACTION BETWEEN YOU AND ANY THIRD-PARTY

PROVIDERS OF PRODUCTS OR SERVICES. AS WITH THE PURCHASE OF A PRODUCT

OR SERVICE THROUGH ANY MEDIUM OR IN ANY ENVIRONMENT, YOU SHOULD USE YOUR BEST JUDGEMENT AND EXERCISE CAUTION WHERE APPROPRIATE.

## 22.  LIMITATIONS OF LIABILITY

IN NO EVENT WILL WE OR OUR DIRECTORS, EMPLOYEES, OR AGENTS BE LIABLE TO YOU

OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, EXEMPLARY,

INCIDENTAL, SPECIAL, OR PUNITIVE DAMAGES, INCLUDING LOST PROFIT, LOST REVENUE,

LOSS OF DATA, OR OTHER DAMAGES ARISING FROM YOUR USE OF THE SERVICES, EVEN

IF WE HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. NOTWITHSTANDING

ANYTHING TO THE CONTRARY CONTAINED HEREIN, OUR LIABILITY TO YOU FOR ANY

CAUSE WHATSOEVER AND REGARDLESS OF THE FORM OF THE ACTION, WILL AT ALL

TIMES BE LIMITED TO THE LESSER OF THE AMOUNT PAID, IF ANY, BY YOU TO US DURING

THE THREE (3) MONTH PERIOD PRIOR TO ANY CAUSE OF ACTION ARISING OR $100.00

USD. CERTAIN US STATE LAWS AND INTERNATIONAL LAWS DO NOT ALLOW LIMITATIONS

ON IMPLIED WARRANTIES OR THE EXCLUSION OR LIMITATION OF CERTAIN DAMAGES. IF THESE LAWS APPLY TO YOU, SOME OR ALL OF THE ABOVE DISCLAIMERS OR LIMITATIONS MAY NOT APPLY TO YOU, AND YOU MAY HAVE ADDITIONAL RIGHTS.

## 23.  INDEMNIFICATION

You agree to defend, indemnify, and hold us harmless, including our subsidiaries, affiliates, and all of our respective officers, agents, partners, and employees, from and against any loss, damage, liability, claim, or demand, including reasonable attorneys’ fees and expenses, made by any third party due to or arising out of: (1) use of the Services; (2) breach of these Legal Terms; (3) any breach of your representations and warranties set forth in these Legal Terms; (4) your violation of the rights of a third party, including but not limited to intellectual property rights; or (5) any overt harmful act toward any other user of the Services with whom you connected via the Services. Notwithstanding the foregoing, we reserve the right, at your expense, to assume the exclusive defence and control of any matter for which you are required to indemnify us, and you agree to cooperate, at your expense, with our defence of such claims. We will use reasonable efforts to notify you of any such claim, action, or proceeding which is subject to this indemnification upon becoming aware of it.

## 24.  USER DATA

We will maintain certain data that you transmit to the Services for the purpose of managing the performance of the Services, as well as data relating to your use of the Services. Although we perform regular routine backups of data, you are solely responsible for all data that you transmit or that relates to any activity you have undertaken using the Services. You agree that we shall have no liability to you for any loss or corruption of any such data, and you hereby waive any right of action against us arising from any such loss or corruption of such data.

## 25.         ELECTRONIC COMMUNICATIONS, TRANSACTIONS, AND SIGNATURES

Visiting the Services, sending us emails, and completing online forms constitute electronic communications. You consent to receive electronic communications, and you agree that all agreements, notices, disclosures, and other communications we provide to you electronically, via email and on the Services, satisfy any legal requirement that such communication be in

writing. YOU HEREBY AGREE TO THE USE OF ELECTRONIC SIGNATURES, CONTRACTS, ORDERS, AND OTHER RECORDS, AND TO ELECTRONIC DELIVERY OF NOTICES,

POLICIES, AND RECORDS OF TRANSACTIONS INITIATED OR COMPLETED BY US OR

VIA THE SERVICES. You hereby waive any rights or requirements under any statutes, regulations, rules, ordinances, or other laws in any jurisdiction which require an original signature or delivery or retention of non-electronic records, or to payments or the granting of credits by any means other than electronic means.

## 26.  CALIFORNIA USERS AND RESIDENTS

If any complaint with us is not satisfactorily resolved, you can contact the Complaint Assistance Unit of the Division of Consumer Services of the California Department of Consumer Affairs in writing at 1625 North Market Blvd., Suite N 112, Sacramento, California 95834 or by telephone at (800) 952-5210 or (916) 445-1254.

## 27.  MISCELLANEOUS

These Legal Terms and any policies or operating rules posted by us on the Services or in respect to the Services constitute the entire agreement and understanding between you and us. Our failure to exercise or enforce any right or provision of these Legal Terms shall not operate as a waiver of such right or provision. These Legal Terms operate to the fullest extent permissible by law. We may assign any or all of our rights and obligations to others at any time. We shall not be responsible or liable for any loss, damage, delay, or failure to act caused by any cause beyond our reasonable control. If any provision or part of a provision of these Legal Terms is determined to be unlawful, void, or unenforceable, that provision or part of the provision is deemed severable from these Legal Terms and does not affect the validity and enforceability of any remaining provisions. There is no joint venture, partnership, employment or agency relationship created between you and us as a result of these Legal Terms or use of the Services. You agree that these Legal Terms will not be construed against us by virtue of having drafted them. You hereby waive any and all defences you may have based on the electronic form of these Legal Terms and the lack of signing by the parties hereto to execute these Legal Terms.

## 28.  CONTACT US

In order to resolve a complaint regarding the Services or to receive further information regarding use of the Services, please contact us at:

CODEMATE INC

8 The Green STE R, Dover, Delaware- 19901, UNITED STATES

Phone: +918766330253 <contact@codemate.ai>


# Privacy Policy

Our promise to protecting your privacy

1. **INTRODUCTION**

   **A2S Innovate Tech Private Limited**, having its registered office at B-14/188 Sector 34, Noida,  Gautam Buddha Nagar Uttar Pradesh, India -201307, is hereinafter referred to as **“We”**,**“Us”**, **“Our'**, **“Company”** or **“CodeMate”**. We have created this Privacy Notice \[hereinafter also referred to as **“Policy”** or **“Notice”** or **“Privacy Statement”**] in order to demonstrate our privacy commitment to our users. We hereby request individuals who qualify as data subjects under the USA privacy regulations including the California Consumer Protection Act (CCPA) and the Children's Online Privacy Protection Act (COPPA), the Indian Digital Personal Data Protection Act (DPDPA), and the EU General Data Protection Regulation (GDPR) to read this statement, together with any privacy statement we may provide on specific occasions when we are collecting or processing personal data about them, so that they are aware about the processing of their personal data throughout its lifecycle.
2. **APPLICABILITY**

   This Policy applies to the personal data all vendors, visitors, existing and prospective customers, existing and prospective employees and other individuals who provide their personal data to the Company and all such individuals are hereinafter referred to as “Data Subject”.
3. **OBJECTIVE OF THIS POLICY**

   This Privacy Policy, as mentioned above, is intended to inform you on how we gather, define, and use Personal Data that you provide to us when using our websites, software (the “Application”) and social media platforms or when relying on our services.

   This Privacy Policy will primarily help you understand:

   1. The nature of personal data we collect from you
   2. The sources from where your personal data is collected (In cases where personal data is not directly collected from you)
   3. The manner in which your personal data is collected
   4. The purpose of collecting your personal data
   5. The manner in which your personal data is stored, used and processed
   6. The data subject rights that can be exercised by you
   7. The process to contact the Company for any issues regarding the collection or use of your personal data or to exercise the above-mentioned rights of the data subject.
4. **CATEGORY OF PERSONAL DATA COLLECTED AND USED**

   Personal Data collected by CodeMate primarily consists of:

   1. Personal Data

      The below personal data elements may be collected from you:

      1. Name
      2. Email id
      3. Location
      4. IP Address
      5. Cookie Data
      6. Social media handles
      7. User tokens provided by different applications
      8. Details pertaining to user connection and disconnection.
   2. Sensitive Personal Data

      We do not collect sensitive personal data via website. In case, sensitive personal data is required to provide services, we will obtain consent or provide notification to data subject before collection.
   3. Cookies

      We may obtain information about your usage of our site by using a cookie file which is stored on your browser or on the hard drive of your computer. Cookies contain information that is transferred to your computer's hard drive. They help us to improve our site and to deliver a better and more personalised service. Some of the cookies we use are essential for the site to operate. If you continue to use our site, you agree to our use of cookies.

      When visitors come to our site, third parties may place cookies on visitors' browsers for targeted advertising purposes. You may avoid that by utilizing ad blocker on your browser.

      The types of data collected will include IP addresses, cookie identifiers, website activity and in the cases where customer fills out a form, it will include all field information filled out by the customer.

      For more details, please contact us- <contact@codemate.ai>
5. **HOW WE COLLECT YOUR DATA**<br>

   We collect your data through various methods to provide and improve our services. These methods include:

   1. **Data provided by visitors on website via web forms, email, chat box, etc.:** When visitors interact with our website, they may choose to provide information through web forms, email inquiries, or chat boxes. This data may include contact details, inquiries, feedback, or any other information voluntarily shared by the visitor.
   2. **Data provided by users when signing up, connecting, or using the application:** Users are required to provide certain information when signing up for or using our application. This information may include personal details such as name, email address, username, password, and any additional information required to create and manage their account or use our services.
   3. **Cookies:** We use cookies and similar technologies to collect information about users' interactions with our website and application. Cookies are small text files stored on users' devices that track user activity, preferences, and session information. Users may adjust their browser settings to refuse cookies or to be notified when cookies are being sent, although this may affect the functionality of our website or application.
6. **PURPOSE OF PROCESSING PERSONAL DATA**<br>

   We use your data to conduct our business and to provide you with the best possible services. Most commonly, we will use your personal data in the following circumstances:

   1. Where we need to perform the service contracts we have entered with you;
   2. Where we need to comply with a legal obligation;
   3. Where it is necessary for our legitimate interests (such as processing personal data to prevent fraud, for internal administrative purposes relating to employees and clients, to ensure network and information security, and to report possible criminal acts or threats to public security to a competent authority), and your interests and data subject rights and interests do not override those legitimate business interests;
   4. To enable use of the services available.
   5. To send statements, invoices and payment reminders and to collect payments;
   6. To send non-marketing commercial communications;
   7. To send email notifications that you have specifically requested for;
   8. To send marketing communications relating to our business or the businesses of carefully-selected third parties where you have specifically agreed to this, by email or similar technology. However, you may inform us at any time if you no longer require such marketing communications;
   9. To provide third parties with statistical information about our users in anonymized or de-identified format wherein those third parties will not be able to identify any individual user from that information;
   10. To deal with enquiries and complaints made;
   11. To keep our website and other systems secure and to prevent fraud;
   12. Where you have given us the explicit consent to do so.
7. **CHANGE OF PURPOSE**<br>

   We will only use your data for the purposes for which we collected it, unless we reasonably consider that we need to use it for another reason and that reason is compatible with the original purpose.

   If we need to use your personal data for an unrelated purpose, we will notify you and we will explain the legal basis, which allows CodeMate to do so.

   Please note that we may process your personal data without knowledge or consent, in compliance with the above rules, where it is required or permitted by law.

   Please note that if you wish to opt-out of any such processing activities for purposes other than the original purpose, you can reach out to us by writing to us at: <contact@codemate.ai>
8. **USE OF SERVICES BY MINORS (CHILDREN DATA)**<br>

   We are committed to protecting the privacy of children online in compliance with the privacy regulations including the Children's Online Privacy Protection Act (COPPA). Our services are not directed to children under the age of 13, and we do not knowingly collect personal information from children under this age. If you are a parent or guardian and believe that your child has provided us with personal information without your consent, please contact us immediately so that we can take appropriate action.

   In instances where we may collect personal information from children under 13 with parental consent, we adhere to the following guidelines:

   1. **Parental Consent:** We obtain verifiable parental consent before collecting, using, or disclosing personal information from children under the age of 13. This consent may be obtained through various means, such as a consent form signed by the parent or guardian, a credit card transaction, or a toll-free phone number.
   2. **Notice to Parents:** We provide parents or legal guardians with clear notice of our information practices regarding children's personal information, including the types of information collected, how it is used, and any disclosures to third parties.
   3. **Limited Information Collection:** We collect only the minimum amount of personal information necessary to participate in the activity, service, or contest for which the information is being collected. We do not condition a child's participation in an activity on the disclosure of more personal information than is reasonably necessary to participate.
   4. **Parental Rights:** Parents or legal guardians have the right to review the personal information collected from their children, request its deletion, and refuse further collection or use of the information. They can exercise these rights by contacting us using the contact information provided below.
   5. **Data Security:** We maintain reasonable security measures to protect the confidentiality, security, and integrity of the personal information collected from children, including encryption, restricted access, and regular security assessments.
   6. **Retaining Parental Consent Records:** We retain records of verifiable parental consent for a reasonable period of time to ensure compliance with COPPA and other privacy regulations.
9. **WHERE DO WE STORE DATA**<br>

   Your data is securely stored within the infrastructure provided by Microsoft Azure, specifically Azure Blob Storage and Azure Cosmos DB. These services offer robust security features and compliance certifications to ensure the confidentiality, integrity, and availability of your information.

   **Azure Blob Storage**: Your data files, documents, and other stored content are housed within Azure Blob Storage, a highly scalable and durable object storage service. Azure Blob Storage utilizes multiple layers of security controls, encryption methods, and access management features to safeguard your data against unauthorized access, data loss, and other security threats.

   **Azure Cosmos DB**: Your structured data and database records are stored in Azure Cosmos DB, a fully managed NoSQL database service. Cosmos DB provides high availability, automatic scaling, and built-in security features to protect your data at rest and in transit. Additionally, Cosmos DB offers encryption options and access controls to ensure the confidentiality and integrity of your stored information.

   **Security Measures**

   Both Azure Blob Storage and Azure Cosmos DB adhere to industry-leading security best practices and compliance standards, including but not limited to:

   * **Encryption**: Data stored in Blob Storage and Cosmos DB can be encrypted using encryption keys managed by Azure Key Vault for enhanced security.
   * **Access Controls**: Access to your data within Blob Storage and Cosmos DB is controlled through Azure Active Directory (AAD), allowing us to manage permissions and restrict access based on roles and policies.
   * **Compliance**: Azure undergoes regular security audits and certifications, including SOC 1, SOC 2, ISO 27001, HIPAA, and GDPR, to demonstrate adherence to industry standards and regulatory requirements.
10. **INFORMATION SHARING AND DISCLOSURE**<br>

    We may disclose your personal data to our employees, officers, insurers, professional advisers, agents, partners, suppliers, vendors or subcontractors insofar as reasonably necessary for the purposes set out in this policy and for the purpose of providing services to you. We may share user data with third-party vendors to enhance and support our services. These vendors include Meilisearch and OpenAI. Additionally, we will be sharing user keys with Truto for specific purposes. These third-party vendors are carefully selected based on their capabilities and commitment to data security and privacy.

    **Purpose of Data Sharing:**\
    User data may be shared with these third-party vendors for various purposes, including but not limited to:

    * Enhancing the functionality and features of our services.
    * Providing personalized experiences and recommendations.
    * Conducting data analysis and research to improve our products and services.
    * Facilitating specific integrations or partnerships to deliver additional value to users.

    **Data Protection Measures:**\
    We take appropriate measures to ensure the confidentiality, integrity, and security of user data when sharing it with third-party vendors. These measures include:

    * Implementing data processing agreements with vendors to outline data protection obligations.
    * Restricting access to user data to only those individuals or systems necessary for the intended purposes.
    * Regularly monitoring and auditing third-party vendors' compliance with data protection standards.
    * Encrypting sensitive data and employing secure transfer methods to prevent unauthorized access or interception.

    **User Consent and Control:**\
    We obtain user consent where required by law or regulation before sharing any personally identifiable information with third-party vendors. Users may have the option to opt out of certain data sharing activities or revoke consent at any time by adjusting their privacy settings or contacting us directly.

    Except as provided in this policy, we will not provide your personal data to any other third party.
11. **CROSS-BORDER DATA TRANSFERS**<br>

    We may transfer your data across borders to fulfill the purposes outlined in this privacy notice. Specifically, your data is primarily stored in data centers located in the Mumbai region while at rest. However, it may be necessary to share your data with third-party vendors located in the United States, such as OpenAI, to provide certain services or functionalities.

    **Purpose of Cross-Border Data Transfer:** The cross-border transfer of your data to the United States is conducted to enable collaboration with trusted third-party vendors for purposes such as data analysis, machine learning, and enhancing the functionality of our services. These vendors have been carefully selected based on their expertise, reliability, and commitment to data protection standards.

    **Data Protection Measures:** We take appropriate measures to ensure the security and confidentiality of your data during cross-border transfers, including:

    * Implementing data processing agreements or similar legal mechanisms with third-party vendors to ensure they provide an adequate level of protection for your data.
    * Utilizing encryption and secure transfer protocols to safeguard data during transit.
    * Conducting due diligence on third-party vendors to assess their data protection practices and compliance with relevant regulations.

    **Consent to Cross-Border Data Transfer:** By using our services and consenting to this privacy notice, you acknowledge and agree to the transfer of your data to the United States as described above. You also consent to the processing of your data by third-party vendors in accordance with their respective privacy policies and terms of service.
12. **AUTOMATED DECISION-MAKING**<br>

    Automated decision-making takes place when an electronic system uses personal information to make a decision without human intervention.

    We do not envisage that any decisions will be taken about you using automated means. However, we will notify you in writing if there is any adoption of such techniques in our business processes.
13. **DATA SECURITY**<br>

    We take data security seriously and employ industry best practices to safeguard your information. Our commitment to protecting your data includes adhering to the principles of security and privacy established by relevant regulations, including those in the United States. All information you provide to us will be secured using strict procedures and security features to try to prevent accidental or unlawful destruction, loss, alteration, unauthorized disclosure of, or access to, personal data transmitted, stored or otherwise processed by us.

    **Best Practices and Principle of Least Privilege:** We implement and follow the principle of Least Privilege, which ensures that access to your data is restricted to only those individuals or systems that require it to perform their designated tasks. This practice minimizes the risk of unauthorized access, data breaches, and misuse of information.

    **Encryption Standards:** Your data is encrypted using the Advanced Encryption Standard (AES) with a key length of 256 bits (AES-256). AES-256 is a widely recognized and trusted encryption algorithm that provides a high level of security by converting your data into an unreadable format that can only be decrypted with the appropriate encryption key. This encryption ensures the confidentiality and integrity of your data both at rest and in transit.

    **Additional Security Measures:** In addition to encryption and the principle of Least Privilege, we implement a range of security measures (technical and organisational measures) to protect your data, including but not limited to:

    * Access control policy and procedures in place: We have established and documented guidelines for controlling access to data and systems, including role-based access control and segregation of access control roles. We employ access controls and authentication mechanisms to verify the identity of users and restrict access to authorized personnel only.
    * Asset management: We maintain an inventory and tracking system for all digital and physical assets to ensure their security and integrity.
    * Change management: We follow structured procedures for implementing changes to our systems, applications, and infrastructure to minimize risks and maintain stability.
    * Business continuity: We have plans and protocols in place to ensure the continuation of critical operations in the event of disruptions or disasters.
    * Password Management: We enforce secure password practices, including complexity requirements and regular password updates, to protect against unauthorized access.
    * Two-factor authentication: We utilize additional authentication methods beyond passwords, such as biometric verification or one-time codes, to enhance account security.
    * Logging and monitoring: We maintain comprehensive logs of system activities and employ monitoring tools to detect and respond to security incidents in real-time.
    * Network and communication security: We implement measures to secure our network infrastructure and communication channels, including firewalls, encryption, and intrusion detection systems.
    * Backup and Restoration: We regularly back up data and systems to secure locations and have procedures in place for swift restoration in the event of data loss or system failure.
    * Physical and Environmental Security: We have measures in place to protect physical assets and facilities, including access controls, surveillance, and environmental controls to mitigate risks such as theft, vandalism, or environmental hazards.
    * Regular Security Audits: We conduct regular security audits and assessments to identify and address potential vulnerabilities, weaknesses, and threats to our systems and infrastructure.
    * Employee Training: Our employees undergo training on data security best practices and are bound by confidentiality agreements to ensure the protection of your information.

    We strive to maintain compliance with relevant data protection laws and regulations, including but not limited to the requirements outlined by federal and state authorities in the United States. Furthermore, we continuously evaluate and improve our data security practices to adapt to evolving threats and technology advancements.

    By using our services, you acknowledge and consent to the security measures described above. If you have any questions or concerns regarding the security of your data, please contact us at <contact@codemate.ai>
14. DATA RETENTION<br>

    We will only retain your data for as long as necessary to fulfil the purposes we collected it for, including for the purposes of satisfying any legal, accounting, or reporting requirements. Your data will be stored in our secure servers. We will destroy the personal data in a secure manner post retention period as per our internal data retention and destruction policy.

    In addition, we retain certain types of data for specified periods to fulfill our business and legal obligations. The retention periods for different categories of data are as follows:

    **Analytics Data:** We retain analytics data, which includes aggregated and anonymized information about user interactions with our services, indefinitely for historical analysis, reporting, and improvement purposes. This data does not contain personally identifiable information and is used to understand usage trends and optimize our services.

    **User Credentials Data:** User credentials data, such as usernames, email addresses, and encrypted passwords, is retained for as long as the user maintains an active account with us. If a user chooses to deactivate or delete their account, their credentials data will be deleted accordingly. However, if the user requests deletion of their account, we will securely delete their credentials data upon verification of the request.

    **Search Query Data:** Search queries entered by users are retained for 01 year unless the user requests deletion of their data. We understand the sensitivity of search queries and will honor user requests to delete this data promptly.

    You have the right to request access to, rectification of, or deletion of your personal information retained by us. If you would like to exercise your rights or have any questions about our data retention practices, please contact us at <contact@codemate.ai>
15. **DATA SUBJECT RIGHTS**<br>

    RIGHTS UNDER THE DPDPA (INDIA)

    Under the Data Protection and Privacy Act (DPDPA), you have certain rights regarding the processing of your personal data. These rights include:

    **Right to Access Information about Personal Data:** You have the right to obtain confirmation from us as to whether or not your personal data is being processed and, if so, to access the personal data and information about how it is being processed.

    **Right to Correction:** You have the right to request the correction of inaccurate or incomplete personal data concerning you.

    **Right to Erasure:** You have the right to request the erasure of your personal data under certain circumstances, such as when the data is no longer necessary for the purposes for which it was collected or when you withdraw your consent.

    **Right to Nominate:** You have the right to nominate individuals to exercise their rights in case of death or incapacity.

    **Right to Grievance Redressal:** If you believe that we have violated your data protection rights under the Indian DPDPA, you have the right to accessible grievance redressal mechanisms through us, ensuring prompt responses within prescribed timeframes. Before seeking higher authorities, you must exhaust this redressal opportunity, promoting effective dispute resolution.

    RIGHTS UNDER THE GDPR (EUROPEAN UNION)

    Under the General Data Protection Regulation (GDPR), you have certain rights regarding the processing of your personal data. These rights include:

    **Right to Access:** You have the right to obtain confirmation as to whether or not your personal data is being processed, and, if so, to access the personal data and information about how it is being processed.

    **Right to Rectification:** You have the right to request the rectification of inaccurate or incomplete personal data concerning you.

    **Right to Erasure:** You have the right to request the erasure of your personal data under certain circumstances, such as when the data is no longer necessary for the purposes for which it was collected or when you withdraw your consent.

    **Right to Restriction of Processing:** You have the right to request the restriction of processing of your personal data under certain circumstances, such as when you contest the accuracy of the data or when the processing is unlawful.

    **Right to Data Portability:** You have the right to receive the personal data concerning you, which you have provided to us, in a structured, commonly used, and machine-readable format, and to transmit that data to another controller where technically feasible.

    **Right to Object:** You have the right to object to the processing of your personal data under certain circumstances, such as when the processing is based on legitimate interests or for direct marketing purposes.

    **Rights in Relation to Automated Decision Making and Profiling:** You have the right not to be subject to a decision based solely on automated processing, including profiling, which produces legal effects concerning you or similarly significantly affects you.

    **Withdrawal of Consent:** If we are processing your Personal Information based on your consent (as indicated at the time of collection of such data), you have the right to withdraw your consent at any time. Please note, however, that if you exercise this right, it may limit your ability to use some/ all of our Services or Platform and you may have to then provide express consent on a case-by-case basis for the use or disclosure of certain of your Personal Information, if such use or disclosure is necessary to enable you to utilize some or all of our Services and Platform.

    **Right to File Complaint:** You have the right to lodge a complaint about our practices with respect to your Personal Information with the supervisory authority of your country or EU Member State. Please go to <https://ec.europa.eu/justice/article-29/structure/data-protection-authorities/index_en.html> to locate your Data Protection Authority in the EU. You may contact the UK's Information Commissioner at <https://ico.org.uk/make-a-complaint> or by telephone: 0303 123 1113.

    RIGHTS UNDER THE USA PRIVACY REGULATIONS

    **California:** Under California Consumer Protection Act and Civil Code, CodeMate does not sell, trade, or transfer your Personal Information to third parties. California residents have the right to request information about disclosure of their Personal Information to third parties for direct marketing purposes. Please note that deleting Personal Information may affect service provision, and we may retain it during shutdown and billing processes.

    **Massachusetts:** Residents of Massachusetts have rights under the Massachusetts Data Protection Law (201 CMR 17.00). These include:

    * \- Access to personal information.
    * \- Correction of inaccurate or incomplete personal information.
    * \- Deletion of personal information.
    * \- Opt-out of personal information collection, use, or disclosure for marketing.
    * \- Notification of data breaches.
    * \- Opt-in for Sensitive Personal Information. To file a complaint, contact the Massachusetts attorney general at (617) 727-8400 or file a complaint at <https://www.mass.gov/how-to/file-a-consumer-complaint>

    **Colorado:** CodeMate does not currently fall under the Colorado Privacy Act (Colo. Rev. Stat. § 6-1-1301 et seq.). We will update our Privacy Policy if this law applies in the future.

    **Connecticut:** CodeMate does not sell, trade, or transfer Personal Data under Connecticut's Privacy Act. We will update our Privacy Policy if this law applies in the future.

    **New York:** The New York Privacy Act grants rights to access, correct, delete, and disclose Personal Information. Contact us for more information.

    **Virginia:** The Virginia Consumer Data Protection Act (Va. Code § 59.1-571 et seq.) becomes effective from January 1, 2023. We will update our Privacy Policy accordingly.

    **COPPA Compliance:** Our platform complies with the Children's Online Privacy Protection Act (COPPA) by not collecting Personal Information from children under 13. If you are under 13, do not use our platform.

    **CAN-SPAM Act of 2003:** We comply with the CAN-SPAM Act by:

    * \- Not using false or misleading subjects or email addresses.
    * \- Identifying emails as advertisements.
    * \- Including our physical address in emails.
    * \- Monitoring third-party email marketing services.
    * \- Honoring opt-out requests promptly.

    If you wish to opt out of email marketing, follow the instructions at the bottom of each email or contact us at <contact@codemate.ai> and we will promptly remove you from all future marketing correspondences.
16. HOW TO EXERCISE YOUR DATA SUBJECT RIGHTS<br>

    If you wish to exercise any of the rights listed above, with respect to this Privacy Policy, our Terms or Use, and/or Personal Data, please contact us at <contact@codemate.ai>. We will respond to your request without undue delay and in any event within one month of receipt of the request. We may extend this period by two further months where necessary, taking into account the complexity and number of requests.

    **No Fee Usually Required:** There is no fee required to exercise your rights under the GDPR. However, if your requests are manifestly unfounded or excessive, we may charge a reasonable fee or refuse to act on the request. Rights of Data Subjects.

    For your protection, we may only implement requests with respect to the personal data associated with the particular email address that you use to send us your request, and we may need to verify your identity before implementing your request. The Company will act on all data subject requests received without undue delay and respond within one month (30 days) of receipt, post completion of necessary verification checks.

    **Please note** that we may need to retain certain personal data for record-keeping purposes and/or to complete any undertaking that you began prior to requesting a change or deletion. There may also be residual information which may be subject to a legal hold or subject to certain sectoral or regulatory retention requirements that will remain within our databases and other records, which will not be removed.

    **Please note**r that (i) if we delete your Personal Information as requested, we will no longer be able to provide our services to you and (ii) we may need to keep such Personal Information for a while during the shutting down and billing process.

    **Please note** that if you opt-out of receiving direct marketing from us, we may still send you important administrative messages via email, such as invoicing and payment details, current status of dispatch or delivery of purchased products, etc. from which you cannot opt out (unless an applicable retention schedule or right to erasure request requires deletion of such email address).

    **Withdraw consent:** If you withdraw your consent for the use or disclosure of your personal data for purposes set out in this Privacy Notice, you may not have access to all our Services and we might not be able to provide you all of the Services and customer support offered to our users and authorized under this Privacy Notice. We will continue to send updates to you about any existing orders or enquiries for purchase of products or services that you have made from us in the past.
17. DATA PROTECTION OFFICER<br>

    We have appointed a Data Protection Officer (DPO) to oversee our compliance with data protection laws and regulations. The DPO's role includes monitoring our data processing activities, providing advice and guidance on privacy matters, and serving as a point of contact for data subjects and regulatory authorities.

    If you have any questions, concerns, or requests related to the processing of your personal information or our privacy practices, you may contact our Data Protection Officer using the following contact information: <contact@codemate.ai>

    We are committed to complying with all applicable data protection laws and regulations, and we will make reasonable efforts to ensure that your personal information is processed in accordance with these regulations.

    If you have any questions or concerns about this Data Protection Officer clause or our privacy practices, please contact our Data Protection Officer at the provided contact information.
18. GRIEVANCE REDRESSAL<br>

    If you have any questions, grievances, or requests regarding the processing of your personal information or our privacy practices, please contact us using the following contact information:

    Email ID: <contact@codemate.ai>&#x20;

    Procedure for Grievance Redressal:

    * **Submission of Grievance:** You can submit your grievance or complaint to us via email, mail, or through our designated grievance redressal portal, if available. Please provide as much detail as possible to help us understand the nature of your concern.
    * **Investigation:** Upon receipt of your grievance, we will promptly initiate an investigation to assess the validity of your concerns and determine the appropriate course of action. We may request additional information from you to assist in our investigation.
    * **Response:** We will provide you with a written response to your grievance within a reasonable timeframe, typically within \[insert timeframe as per internal policies or regulatory requirements]. Our response will include the outcome of our investigation and any remedial actions taken or proposed.
    * **Appeal Process:** If you are not satisfied with our response or believe that your grievance has not been adequately addressed, you may have the right to escalate your complaint to relevant regulatory authorities or seek legal remedies as provided by applicable laws.

    We will not retaliate against you for filing a grievance or complaint regarding the processing of your personal information. Your privacy rights are important to us, and we are committed to addressing your concerns in a fair and transparent manner.

    We are committed to complying with all applicable privacy regulations and will make reasonable efforts to ensure that your personal information is processed in accordance with these regulations.
19. CHANGES TO THIS PRIVACY POLICY<br>
    1. (a) The policy is subject to modification from time to time. If we decide to change our policy, we will post those changes here with date of change and version history so that you will always know what personal data we gather, how we might use that personal data and whether we will disclose it to anyone.
    2. (b) We may also notify you in other ways such as email from time to time and notification in the application about changes or modifications to our privacy policy.


# Refund Policy

At CodeMate, your satisfaction is our priority. If you are not fully satisfied with your purchase, you can request a refund under the following terms:<br>

* To initiate a refund, please email us at <contact@codemate.ai> within 14 days of your purchase date.
* Refund requests submitted after 14 days of the purchase will not be eligible for a refund.
* Upon receiving a valid request, we will process the refund within 7–14 business days.
* Please note that payment gateway fees are non-refundable and will be deducted from the refunded amount.

For any questions or concerns regarding refunds, feel free to reach out to our support team.


# Fair Usage Policy

To ensure a smooth and equitable experience for all users, CodeMate enforces a Fair Usage Policy. Our AI tools are powerful, and we encourage extensive use—but within reasonable limits. Excessive or abusive usage that impacts system performance or hinders access for others is not permitted. This includes overloading our services with automated requests, circumventing limits, or using the platform for non-developmental purposes. We reserve the right to monitor usage patterns and take necessary action, including throttling or suspension, to maintain service quality for everyone


# Community Guidelines

CodeMate aims to foster a respectful, collaborative, and inclusive developer community. We ask all users to engage constructively, avoid harassment or discrimination, and maintain a positive environment. Whether you're interacting via our forums, Discord, or sharing content through CodeMate, be mindful of your language, provide helpful feedback, and respect others’ work. Misuse of the platform-such as spreading misinformation, exploiting AI-generated content maliciously, or violating others’ privacy-may result in warnings or account action. Together, let’s build a community that’s supportive, safe, and driven by innovation.


