docs

A command for creating software documentation such as API references, README files, and developer guides. API documentation explains how program interfaces can be used.

In plain words
What is it for?
It is for documenting APIs, writing or updating READMEs, and producing guides that explain setup, features, prerequisites, and usage.
Why use it?
It helps locate missing or outdated documentation and gather details from source code, project files, tests, and existing guides.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/cloudai-x/opencode-workflow/docs
Clone the repo
git clone --depth 1 https://github.com/CloudAI-X/opencode-workflow
Per session 12 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 980 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00012 $0.00980
Opus 5 $0.00006 $0.00490
Sonnet 5 $0.00002 $0.00196
Haiku 4.5 $0.00001 $0.00098

Measured 2d ago against content hash 30aa8fb85750, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/docs.md · 216 lines

How it starts

The opening of the file, as written. The whole thing — 216 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Generation Command

Generate comprehensive documentation using the docs-writer subagent. Creates API documentation, READMEs, and developer guides.

Phase 1: Documentation Discovery

Determine documentation needs:

  1. If $ARGUMENTS specifies type (api, readme, guide), focus on that
  2. Otherwise, analyze project to identify documentation gaps:
    • Missing README.md
    • Undocumented APIs
    • Missing inline comments
    • Outdated documentation

Phase 2: Context Gathering

Collect information for documentation:

For API Documentation

  • Read source files with public interfaces
  • Extract function signatures, parameters, return types
  • Find existing JSDoc/docstrings
  • Identify example usage in tests

For README

  • Read package.json / pyproject.toml for project metadata
  • Check existing README for structure to maintain
  • Look for setup scripts and configuration
  • Find example code or demos

For Guides

  • Understand the feature/workflow being documented
  • Identify prerequisites and dependencies
  • Find related code and configuration

Phase 3: Documentation Generation

API Documentation Template

# API Reference

## Module: [module_name]

### `functionName(param1, param2)`

Brief description of what this function does.

**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| param1 | string | Yes | Description |
| param2 | Options | No | Configuration options |

**Returns:** `ReturnType` - Description of return value

**Throws:**
- `ErrorType` - When condition occurs

**Example:**
\`\`\`typescript
const result = functionName('value', { option: true });
\`\`\`

**See Also:** [Related Function](#related)

README Template

# Project Name

Brief description of what this project does.

## Features

- Feature 1
- Feature 2

## Installation

\`\`\`bash
npm install package-name
\`\`\`

## Quick Start

\`\`\`typescript
import { something } from 'package-name';

// Basic usage example
\`\`\`

## Configuration

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| option1 | string | 'default' | What it does |

## API Reference

[Link to full API docs]

## Contributing

[Contributing guidelines]

## License

[License info]

Read the full file on GitHub · 216 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 216 lines · 12 tokens per session scan A 30aa8fb85750

Subscribe to this mod's changes

docs is a command published in the GitHub repository CloudAI-X/opencode-workflow (274 stars, last pushed 7mo ago), licensed MIT. It adds 12 tokens to every session and 980 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.