Documentation

Learn how to integrate Code Charter with your AI coding assistants and enforce engineering standards at scale.

Getting Started

Complete onboarding guide from installation to first sync. Perfect for new users.

  • • Creating API tokens
  • • Registering projects
  • • Syncing rules
  • • IDE setup

CLI Tool Guide

Complete reference for the Convext CLI with all commands and options.

  • • All commands & options
  • • Bootstrapping workflows
  • • CI/CD integration
  • • Troubleshooting

Core Concepts

Deep dive into data models, relationships, and best practices.

  • • Techs & hierarchies
  • • Rules & severity levels
  • • Language Standards
  • • RuleSets & scoping

IDE & Agent Platforms

Connect to 15+ agentic coding platforms: Cursor, Claude, Copilot, Gemini CLI, Antigravity & more.

  • • MCP integration guide
  • • Platform support matrix
  • • Setup instructions per IDE
  • • Dotfile fallbacks

Admin Guide

Manage techs, rules, language standards, and rulesets.

  • • Creating techs
  • • Writing rules
  • • Building standards
  • • Marketplace publishing

API Reference

Complete MCP tools and REST API documentation.

  • • MCP tools (8 total)
  • • MCP resources
  • • Authentication
  • • Error handling

Quick Start

1

Create an API Token

Visit Settings → API Tokens and create a new token. Copy it immediately.

export CONVEXT_TOKEN="cc_live_..."
2

Install the CLI

Install globally or use via npx:

npm install -g @convext/cli
# or
npx @convext/cli init
3

Sync Rules

Generate IDE configuration files:

cd your-project
npx @convext/cli sync

New to Code Charter?

Start with the Getting Started Guide for a complete walkthrough.

MCP Integration

Code Charter implements the Model Context Protocol (MCP) with OAuth 2.1 authentication, allowing AI assistants to fetch your organization's engineering standards in real-time.

Claude Code / Cursor

Create .mcp.json in your project root:

{
  "mcpServers": {
    "convext": {
      "url": "https://convext.app/mcp",
      "transport": "http"
    }
  }
}

OAuth authentication happens automatically in your browser.

GitHub Copilot

Copilot automatically reads the generated instructions file:

convext sync --format copilot

# Generates:
# .github/copilot-instructions.md
Learn more: See the IDE Integration Guide for detailed setup instructions.

Available MCP Tools

get_rules

Get all engineering rules and guidelines

get_tech_standards

Get technology standards (filterable by language)

register_project

Register a new project

get_project_context

Get full context for a project

browse_marketplace

Browse public rulesets

get_plans

Get plans and tasks for a project

Complete reference: View the API Reference for detailed documentation on all tools.