Integrations overview

OpenDocs is designed to slot into the tools developers already use. Every integration follows the same pattern: the tool writes Markdown, runs the OpenDocs CLI, and returns the published URL. No plugins, no custom APIs, no configuration files to maintain.

The common setup

Every integration starts with two commands:

npm install -g @opendocs.cc/cli
opendocs login

After that, the tool can publish, update, list, pull, and unpublish docs using the CLI. If the tool supports persistent instructions (like SKILL.md, .cursorrules, or custom instructions), point it at the OpenDocs SKILL.md so it remembers the workflow across sessions.

Why the CLI is the integration layer

Even when the experience feels "agent-native," the integration surface is intentionally simple:

• One CLI — every tool calls the same opendocs binary
• One API key model — authenticate once with opendocs login, or set an OPENDOCS_API_KEY environment variable for CI/headless environments
• One publish/update lifecycle — publish creates a doc, update revises it, unpublish removes it
• One stable URL format — opendocs.cc/<username>/<slug> never changes after publishing

This means any tool that can write a file and run a shell command can publish to OpenDocs. There is nothing tool-specific to install or configure.

Best practices for any tool

Practice	Why
Ask the tool to save Markdown to a file first	Separates content creation from publishing — easier to review before it goes live
Use --json when the tool needs to parse results	Returns structured output with url, postId, slug instead of terminal formatting
Default to workspace visibility	Internal docs stay visible to your team only — use --visibility public when you intentionally want a public URL
Return the final URL in the tool's answer	Gives you a clickable link without digging through terminal output
Include the postId for iterative workflows	Lets the tool call opendocs update <postId> on follow-up tasks

Key CLI flags for agent workflows

# Publish with JSON output (recommended for all agent integrations)
opendocs publish doc.md --json

# Publish with explicit title and slug
opendocs publish doc.md --title "API Reference" --slug api-reference --json

# Publish with tags for organization
opendocs publish doc.md --tags "api,v2,internal" --json

# Update an existing doc
opendocs update <postId> doc.md --json

# Change visibility after publishing
opendocs visibility <postId> public

Tool-specific guides

Each guide below covers setup, example prompts, common workflows, and tips specific to that tool:

• OpenClaw — terminal-native agent with full shell access
• Codex — OpenAI's CLI agent for multi-file tasks
• Claude Code — Anthropic's CLI agent with SKILL.md support
• Cursor — IDE agent with terminal and file access
• GitHub Copilot — IDE agent with terminal command support
• Cline — VS Code extension with autonomous tool use
• Aider — terminal-based pair programming tool