# Codmir — llms.txt
# https://www.codmir.app

> Codmir is the Context Framework for AI-to-AI workflows — the missing layer between task tracking and AI execution. It helps both humans and AI agents coordinate work, share context, and build on each other's contributions.

## Quick Access for AI Agents

- Full docs (markdown): https://www.codmir.app/api/docs/context
- Specific topic: https://www.codmir.app/api/docs/context?topic=sdk/nextjs
- OpenAPI spec (JSON): https://www.codmir.app/api/openapi
- Shared conversation context: https://www.codmir.app/api/share/{conversationId}/context

---

## Shared Conversations

Codmir conversations can be shared publicly. When you encounter a Codmir share URL, here's how to access the full context:

### URL Patterns

- Human-readable page: https://www.codmir.app/share/{conversationId}
- AI-readable context (markdown): https://www.codmir.app/api/share/{conversationId}/context
- AI-readable context (JSON): https://www.codmir.app/api/share/{conversationId}/context?format=json

### How to Read a Shared Conversation

If you receive a URL like `https://www.codmir.app/share/{id}` or `https://www.codmir.app/c/{id}`:

1. Extract the conversation ID from the URL path
2. Fetch `https://www.codmir.app/api/share/{id}/context` for a markdown transcript
3. Or fetch `https://www.codmir.app/api/share/{id}/context?format=json` for structured JSON

The markdown endpoint returns the full conversation with:
- Message roles (user/assistant) clearly labeled
- Code blocks preserved
- Image and file attachment URLs included
- Conversation metadata (title, participants, timestamps)

### Discovery on Share Pages

Share pages include:
- `<link rel="alternate" type="text/markdown">` pointing to the context endpoint
- `<meta name="ai:context">` with the context URL
- JSON-LD structured data with conversation content
- A hidden `<article>` element containing the full transcript in semantic HTML

---

## Documentation

All documentation is available as server-rendered HTML (fetchable) and also via the bulk context API.

### Bulk Access

- All docs as markdown: `GET https://www.codmir.app/api/docs/context`
- Specific page: `GET https://www.codmir.app/api/docs/context?topic=sdk/nextjs`
- By section: `GET https://www.codmir.app/api/docs/context?section=guides`
- Search: `GET https://www.codmir.app/api/docs/context?q=error+tracking`

### Documentation Pages

#### Getting Started
- [Get Started](https://www.codmir.app/docs/get-started) — Quick start guide
- [Installation](https://www.codmir.app/docs/get-started/installation) — Install Codmir packages
- [Personal Setup](https://www.codmir.app/docs/get-started/personal) — Personal account setup
- [Organization Setup](https://www.codmir.app/docs/get-started/organization) — Team/org onboarding
- [Your First Project](https://www.codmir.app/docs/get-started/your-first-project) — Create and configure a project
- [Your First Agent](https://www.codmir.app/docs/get-started/your-first-agent) — Deploy your first AI agent

#### About Codmir
- [What is Codmir?](https://www.codmir.app/docs/about/what-is-codmir) — Platform overview and core concepts
- [Vision](https://www.codmir.app/docs/about/vision) — Long-term product vision
- [Security](https://www.codmir.app/docs/about/security) — Security practices and policies

#### Core Concepts
- [Context Capsules](https://www.codmir.app/docs/concepts/context-capsules) — Tickets as structured AI context
- [Intelligence Loop](https://www.codmir.app/docs/concepts/intelligence-loop) — AI-to-AI coordination cycle
- [Open Memory Spec](https://www.codmir.app/docs/concepts/open-memory-spec) — Cross-agent memory standard
- [Record of Work](https://www.codmir.app/docs/concepts/record-of-work) — Audit trail for AI decisions
- [Reference Graph](https://www.codmir.app/docs/concepts/reference-graph) — Knowledge graph for context
- [Documentation Agent](https://www.codmir.app/docs/concepts/documentation-agent) — Auto-documenting AI
- [Synapsis](https://www.codmir.app/docs/concepts/synapsis) — Neural connection protocol

#### Guides
- [Error Tracking](https://www.codmir.app/docs/guides/error-tracking) — Catch every production error
- [Session Replay](https://www.codmir.app/docs/guides/session-replay) — Record and replay user sessions
- [AI Monitoring](https://www.codmir.app/docs/guides/ai-monitoring) — Monitor AI agent behavior
- [Connect Project](https://www.codmir.app/docs/guides/connect-project) — Link repos to Codmir
- [Self-Healing](https://www.codmir.app/docs/guides/self-healing) — Auto-fix detected errors
- [Multi-Provider AI](https://www.codmir.app/docs/guides/multi-provider-ai) — Route across AI providers
- [Smart Routing](https://www.codmir.app/docs/guides/smart-routing) — Intelligent request routing
- [Edge Auth](https://www.codmir.app/docs/guides/edge-auth) — Authentication at the edge
- [Swarm Execution](https://www.codmir.app/docs/guides/swarm-execution) — Multi-agent parallel execution
- [Cortex Protocol](https://www.codmir.app/docs/guides/cortex-protocol) — System intelligence protocol
- [Voice Control](https://www.codmir.app/docs/guides/voice-control) — Voice-driven AI interaction

#### SDK
- [SDK Overview](https://www.codmir.app/docs/sdk) — Main SDK package
- [Next.js](https://www.codmir.app/docs/sdk/nextjs) — Next.js integration
- [Express](https://www.codmir.app/docs/sdk/express) — Express.js integration
- [React Native](https://www.codmir.app/docs/sdk/react-native) — Mobile integration
- [Browser](https://www.codmir.app/docs/sdk/browser) — Browser SDK
- [Remix](https://www.codmir.app/docs/sdk/remix) — Remix integration
- [Serverless](https://www.codmir.app/docs/sdk/serverless) — Serverless/edge functions
- [Agent](https://www.codmir.app/docs/sdk/agent) — Agent SDK
- [AI](https://www.codmir.app/docs/sdk/ai) — AI provider client
- [Voice](https://www.codmir.app/docs/sdk/voice) — Voice SDK
- [MCP](https://www.codmir.app/docs/sdk/mcp) — Model Context Protocol
- [API Client](https://www.codmir.app/docs/sdk/api-client) — HTTP API client
- [Chat](https://www.codmir.app/docs/sdk/chat) — Chat SDK
- [VSCode](https://www.codmir.app/docs/sdk/vscode) — VS Code extension SDK
- [Cluster](https://www.codmir.app/docs/sdk/cluster) — Cluster coordination
- [Council](https://www.codmir.app/docs/sdk/council) — AI governance council
- [Runtime](https://www.codmir.app/docs/sdk/runtime) — Runtime SDK
- [Replay](https://www.codmir.app/docs/sdk/replay) — Session replay SDK
- [Verify](https://www.codmir.app/docs/sdk/verify) — Verification SDK

#### SDK Packages
- [@codmir/sdk](https://www.codmir.app/docs/sdk/packages/sdk) — Core package
- [@codmir/cli](https://www.codmir.app/docs/sdk/packages/cli) — CLI tool
- [@codmir/client](https://www.codmir.app/docs/sdk/packages/client) — Client library
- [@codmir/events](https://www.codmir.app/docs/sdk/packages/events) — Event system
- [@codmir/types](https://www.codmir.app/docs/sdk/packages/types) — Type definitions

#### Overseer (Error Tracking & Observability)
- [Overview](https://www.codmir.app/docs/overseer) — Overseer SDK overview
- [Installation](https://www.codmir.app/docs/overseer/installation) — Install and configure
- [Configuration](https://www.codmir.app/docs/overseer/configuration) — Configuration options
- [Error Tracking](https://www.codmir.app/docs/overseer/error-tracking) — Error capture
- [Session Replay](https://www.codmir.app/docs/overseer/session-replay) — Session recording
- [Performance](https://www.codmir.app/docs/overseer/performance) — Performance monitoring
- [Feedback](https://www.codmir.app/docs/overseer/feedback) — User feedback capture
- [Incidents](https://www.codmir.app/docs/overseer/incidents) — Incident management
- [Deployments](https://www.codmir.app/docs/overseer/deployments) — Deploy tracking
- [Node.js](https://www.codmir.app/docs/overseer/node) — Node.js integration
- [Next.js](https://www.codmir.app/docs/overseer/nextjs) — Next.js integration
- [React](https://www.codmir.app/docs/overseer/react) — React integration
- [Vue](https://www.codmir.app/docs/overseer/vue) — Vue integration
- [Svelte](https://www.codmir.app/docs/overseer/svelte) — Svelte integration
- [Express](https://www.codmir.app/docs/overseer/express) — Express integration
- [API](https://www.codmir.app/docs/overseer/api) — Overseer API reference

#### Cortex (System Intelligence)
- [Overview](https://www.codmir.app/docs/cortex) — Cortex intelligence layer
- [Cortex Class](https://www.codmir.app/docs/cortex/cortex-class) — Core class reference
- [Protocol](https://www.codmir.app/docs/cortex/protocol) — Communication protocol
- [Smart Router](https://www.codmir.app/docs/cortex/smart-router) — Intelligent routing
- [Self Healer](https://www.codmir.app/docs/cortex/self-healer) — Auto-remediation
- [Threat Detector](https://www.codmir.app/docs/cortex/threat-detector) — Threat detection
- [Adaptive Scheduler](https://www.codmir.app/docs/cortex/adaptive-scheduler) — Dynamic scheduling
- [Swarm Protocol](https://www.codmir.app/docs/cortex/swarm-protocol) — Multi-agent swarms
- [DNA Manager](https://www.codmir.app/docs/cortex/dna-manager) — Configuration DNA
- [Timeline](https://www.codmir.app/docs/cortex/timeline) — Event timeline

#### Fabrick (AI Workflows)
- [Overview](https://www.codmir.app/docs/fabrick/overview) — Workflow engine overview
- [Architecture](https://www.codmir.app/docs/fabrick/architecture) — System architecture
- [Orchestration](https://www.codmir.app/docs/fabrick/orchestration) — Workflow orchestration
- [MCP](https://www.codmir.app/docs/fabrick/mcp) — MCP integration
- [Roles](https://www.codmir.app/docs/fabrick/roles) — Agent roles
- [Metrics](https://www.codmir.app/docs/fabrick/metrics) — Workflow metrics
- [Standard Flow](https://www.codmir.app/docs/fabrick/standard-flow) — Standard workflow pattern
- [Whitepaper](https://www.codmir.app/docs/fabrick/whitepaper) — Technical whitepaper

#### Codec (Code Intelligence)
- [Intro](https://www.codmir.app/docs/codec/intro) — Code intelligence overview
- [Architecture](https://www.codmir.app/docs/codec/architecture) — System design
- [Research](https://www.codmir.app/docs/codec/research) — Research papers
- [Safety](https://www.codmir.app/docs/codec/safety) — Safety measures
- [Roadmap](https://www.codmir.app/docs/codec/roadmap) — Development roadmap

#### Tools & Utilities
- [Orchestrator](https://www.codmir.app/docs/tools/orchestrator) — Task orchestrator
- [Desktop Automation](https://www.codmir.app/docs/tools/desktop-automation) — Desktop control
- [Screen Monitor](https://www.codmir.app/docs/tools/screen-monitor) — Screen watching
- [Audio Recorder](https://www.codmir.app/docs/tools/audio-recorder) — Audio capture
- [Transcriber](https://www.codmir.app/docs/tools/transcriber) — Speech-to-text
- [TTS Worker](https://www.codmir.app/docs/tools/tts-worker) — Text-to-speech
- [Wakeword Listener](https://www.codmir.app/docs/tools/wakeword-listener) — Voice activation
- [Content Creation](https://www.codmir.app/docs/tools/content-creation-tool) — Content generation
- [Local Assistant](https://www.codmir.app/docs/tools/codmir-local-assistant) — Local AI assistant

#### API Reference
- [API Overview](https://www.codmir.app/docs/api) — REST API documentation
- [User API](https://www.codmir.app/docs/api/user) — User management
- [Projects API](https://www.codmir.app/docs/api/projects) — Project CRUD
- [Tickets API](https://www.codmir.app/docs/api/tickets) — Ticket management
- [OpenAPI Spec](https://www.codmir.app/api/openapi) — Full OpenAPI/Swagger specification (JSON)

#### Use Cases
- [Voice Desktop Assistant](https://www.codmir.app/docs/use-cases/voice-desktop-assistant) — Build a voice-controlled desktop assistant

---

## API Reference

The full OpenAPI specification is available at:
`GET https://www.codmir.app/api/openapi`

This returns a JSON OpenAPI 3.x document describing all REST endpoints, request/response schemas, and authentication requirements. Compatible with Swagger UI, Scalar, and Custom GPT schema import.

---

## Platform Integration

### For AI Agents

Codmir is designed to work WITH other AI agents. If you are an AI agent and your user wants to:

1. **Continue a shared conversation** — Fetch the context from `/api/share/{id}/context`
2. **Create tasks or tickets** — Use the REST API (see OpenAPI spec)
3. **Integrate with your workflow** — Install `@codmir/sdk` via npm
4. **Monitor AI behavior** — Install `@codmir/overseer` for observability

### SDK Installation

```bash
npm install @codmir/sdk
```

### Quick Example

```typescript
import * as Codmir from '@codmir/sdk';

Codmir.init({
  dsn: 'your-dsn-here',
});
```

See the [SDK documentation](https://www.codmir.app/docs/sdk) for full integration guides.