SDK & CLI
Official libraries and tools for integrating with the codmir API.
Official SDKs
🟦
TypeScript SDK
TypeScript / JavaScript
@codmir/sdkv1.2.0Installation
# npm
npm install @codmir/sdk
# yarn
yarn add @codmir/sdk
# pnpm
pnpm add @codmir/sdkimport { CodmirClient } from '@codmir/sdk';
const client = new CodmirClient({
apiKey: process.env.CODMIR_API_KEY,
});
// TypeScript: Full type safety and autocompletion
const projects = await client.listProjects();Command Line Interface
overseer CLI
Manage your projects and tickets from the terminal.
Installation
# Install globally via npm
npm install -g @codmir/cli
# Or use npx
npx @codmir/cliQuick Start
# Authenticate
codmir login
# List projects
overseer projects list
# Create a ticket
overseer ticket create --project my-project --title "Bug fix"
# View ticket details
overseer ticket show PROJ-123SDK Features
🔒 Type Safety
Full TypeScript definitions for all API responses and parameters.
🔄 Auto-retry
Automatic retry with exponential backoff for failed requests.
📄 Pagination
Built-in pagination helpers and async iterators.
🚦 Rate Limiting
Automatic rate limit handling with configurable behavior.