Preparing your workspace...

assistant-chat.tsx2.5k
utils.ts850
button.tsx720
Quick Actions
codmir
Docs
Discord
Get started
API
  • Introduction
  • Installation
  • Your First Project
  • Your First Agent

Command-line interface for Codmir

@codmir/cli

The Codmir CLI provides command-line access to all Codmir features.

Installation

# Global install (recommended)
npm install -g @codmir/cli

# Or use npx
npx @codmir/cli <command>

Authentication

# Login with browser
codmir login

# Or set token directly
export CODMIR_TOKEN=your_token_here

# Verify authentication
codmir whoami

Commands

Chat

Interactive AI chat in your terminal.

# Start interactive chat
codmir chat

# One-shot message
codmir chat "Explain this error: TypeError..."

# With file context
codmir chat --file src/main.ts "Review this code"

# With repo context
codmir chat --repo org/repo "How does auth work?"

CI Commands

Interact with CI/CD workflows.

# Report CI result to Codmir
codmir ci report --run-id $GITHUB_RUN_ID

# List recent CI runs
codmir ci list

# Get CI metrics
codmir ci metrics

# Analyze failures
codmir ci analyze --workflow build.yml

Events

Emit and query events.

# Emit event
codmir events emit ci.deploy.completed \
  --payload '{"env": "production", "version": "1.0.0"}'

# Query events
codmir events query --type "ci.*" --since 24h

# Watch events in real-time
codmir events watch --type "ci.*"

Projects

Manage projects.

# List projects
codmir projects list

# Get project details
codmir projects get <project-id>

# Link current repo to project
codmir projects link

Tickets

Manage tickets.

# List tickets
codmir tickets list --project <project-id>

# Create ticket
codmir tickets create --title "Bug fix" --project <project-id>

# Update ticket
codmir tickets update <ticket-id> --status in_progress

Config

Manage CLI configuration.

# Show config
codmir config show

# Set config value
codmir config set api_url https://api.codmir.com

# Reset config
codmir config reset

GitHub Actions Integration

Use the CLI in your workflows:

name: CI
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Build
        run: npm run build
      
      - name: Report to Codmir
        env:
          CODMIR_TOKEN: ${{ secrets.CODMIR_TOKEN }}
        run: |
          npx @codmir/cli ci report \
            --run-id ${{ github.run_id }} \
            --status success

Environment Variables

VariableDescription
CODMIR_TOKENAPI authentication token
CODMIR_API_URLCustom API URL
CODMIR_DEBUGEnable debug output

Global Options

--token, -t     API token (overrides CODMIR_TOKEN)
--api-url       Custom API URL
--json          Output as JSON
--verbose, -v   Verbose output
--help, -h      Show help
--version       Show version

Examples

Daily Workflow

# Morning: Check what needs attention
codmir tickets list --status open --assigned-to me

# Start work
codmir tickets update TICKET-123 --status in_progress

# Ask AI for help
codmir chat --file src/auth.ts "How can I improve this?"

# End of day: Check CI status
codmir ci list --branch main --limit 5

CI Integration

# In GitHub Actions
- name: Analyze CI Failure
  if: failure()
  env:
    CODMIR_TOKEN: ${{ secrets.CODMIR_TOKEN }}
  run: |
    codmir ci analyze \
      --run-id ${{ github.run_id }} \
      --auto-fix

Next Steps

  • SDK Reference - Programmatic API
  • Events Guide - Event system
  • CI Integration - CI/CD setup
Open in ChatGPTOpen in ClaudeConnect MCP on CursorConnect MCP on WindsurfEdit on GitHub
codmir
Products
Desktop AppMobile AppIDE ExtensionAI AgentsOverseerVoice ModeCortex ProtocolHive MindGame Dev (Godat)PricingDownload
Solutions
AI Code AgentsCode ReviewError TrackingSelf-HealingDeploy TrackingAI Tracking SDKWorkflow AutomationTesting FrameworkTime TrackingVoice Control
Platform
ProjectsTickets & BoardsAgent MarketplaceIntegrationsTemplatesApp HubAdmin PanelAnalytics
Integrations
GitHubSlackDiscordVercelSentryRailwayLinearAll Integrations
Developers
DocumentationAPI ReferenceSDKCLIDeveloper PortalMarketplaceMCP ConnectorsWebhooksExamplesnpm Packages
Resources
BlogChangelogCommunityTutorialsGet StartedSupportStatusFeedback
Company
AboutCareersContact SalesKickstarterReferral Program
Legal
Terms of UsePrivacy PolicyEULATrademarkSecurity
Download on the App StoreGet it on Google Play

Codmir™ 2026. All rights reserved.

Free & open source SDK — Apache 2.0 License