init

A setup procedure for adding docflow documentation to a repository. It creates a documentation folder and guidance files when the repository does not already have meaningful documentation.

In plain words
What is it for?
Use it when initializing docs, scaffolding a new documentation tree, writing docflow configuration, adding agent guidance, linking docs from the README, or creating the first changelog.
Why use it?
It provides a consistent starting structure without replacing existing user-written documentation, and checks first whether setup, adoption, or repair is appropriate.

Skill for Claude CodeCodex

Part of the docflow plugin — 9 skills, 3 commands shipped together

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 skills/medadembha/docflow/init
Any agent
npx skills add MedAdemBHA/docflow --skill init
Clone the repo
git clone --depth 1 https://github.com/MedAdemBHA/docflow

Made for: Claude Code, Codex.

Or install docflow, the plugin that ships this one along with the rest of its 9 skills, 3 commands.

Per session 56 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 629 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.00056 $0.00629
Opus 5 $0.00028 $0.00315
Sonnet 5 $0.00011 $0.00126
Haiku 4.5 $0.00006 $0.00063

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

Security

Grade A, and why

init 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 3d 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.

skills/init/SKILL.md · 59 lines

How it starts

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

init

Goal: initialize docflow only when doctor says this repo has no meaningful docs yet. Keep existing user-authored files; generated maintenance files may be refreshed.

Steps

  1. Run doctor first.
bash scripts/docflow-doctor.sh --target <REPO ROOT>
  1. Route by recommendation.

    • docflow-init: continue.
    • docflow-adopt: stop and run /docflow:adopt instead (preserves existing docs).
    • docflow-repair: stop and run /docflow:repair instead.
  2. Pick docs root.

    • Use docs/ unless the user explicitly chooses another root.
  3. Pick project name.

    • Prefer repo folder name.
    • If root README.md has clear project title, use that.
  4. Run scaffold from plugin root (idempotent; skips existing user content, refreshes generated files):

bash scripts/scaffold.sh --docs-root <DOCS_ROOT> --project "<PROJECT NAME>" --target "<REPO ROOT>"

This creates the category tree, drops templates, writes docflow.json, and scaffolds AGENTS.md + GEMINI.md + .cursorrules.

  1. Add root README link if missing:

    • ## Documentation
    • link to <DOCS_ROOT>/README.md
  2. Seed the first changelog. Create <DOCS_ROOT>/changelog/(mmm-yy).md for the current month from the template, summarizing recent history (git log --no-merges --pretty='%h %ad %s' --date=short -20). Use the changelog skill for the format.

  3. Regenerate the map and validate:

    bash scripts/docflow-map.sh "<REPO ROOT>/<DOCS_ROOT>"
    bash scripts/docflow-validate.sh --target "<REPO ROOT>"
    

    Fresh template placeholders are warnings; validation errors are blockers.

  4. Report what was created (docs root, docflow.json, AGENTS.md, GEMINI.md, .cursorrules, validation status) and point the user at /docflow:author (writing), /docflow:router (reading), /docflow:validate (readiness), /docflow:repair (maintenance).

Rules

  • Never overwrite existing user-authored docs files.
  • If docs already exist, prefer /docflow:adopt over /docflow:init.
  • Keep AGENTS.md and docflow.json aligned on docs root.
  • Follow the naming rules in <DOCS_ROOT>/NAMING.md for every file you create after.

Read the full file on GitHub · 59 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. 3d ago First seen · 59 lines · 56 tokens per session scan A 11a59bc9392f

Subscribe to this mod's changes

init is a skill published in the GitHub repository MedAdemBHA/docflow (41 stars, last pushed 18d ago), licensed MIT. It adds 56 tokens to every session and 629 once invoked, about $0.0003 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.

Related

Other skills, from other repositories

project-context

Resume, handoff, and long-running repo work by keeping durable context across threads or agents: task briefs, logs, and reusable reference notes.

perhapsspy/project-legibility · 32 tokens

codex-project-director

Invoke explicitly with $codex-project-director to act as an active, non-implementing control plane that drives multiple Codex tasks or sessions toward one verified project outcome. Use only for a user-designated director or supervisor session, not a single local task, ordinary implementation, one-off review, or status…

perhapsspy/project-legibility · 70 tokens

tighten-docs

Use by default whenever creating, revising, reviewing, or finalizing human-authored documentation whose source meaning is settled, including documentation changed within another task. Apply from first draft through final review to keep one direct current state, clear reader routes and ownership, and remove rejected…

perhapsspy/project-legibility · 96 tokens

codex-token-discipline

Use for Codex work with clear excess-cost risk: broad or unpredictable logs and diffs, browser/UI loops, subagents, repeated compaction, or explicit usage audits. Guides preflight output limits, bounded delegation, evidence reuse, and compact checkpoints. Skip routine edits, direct answers, and ordinary test runs.

perhapsspy/project-legibility · 69 tokens

interactive-state-flow

Use when an interactive flow is laggy, stale, or race-prone because user intent, source state, derived presentation, async IO, scheduling, or background work are mixed. Keep source state prompt, protect the urgent interaction path, and admit async or presentation results only through a freshness-owning boundary.

perhapsspy/project-legibility · 65 tokens

agents-md-editor

Use when creating, editing, or reviewing AGENTS.md, agents.md, CLAUDE.md, Copilot instructions, Cursor rules, or any always-read repository instruction file. Keep persistent agent instructions small, durable, non-duplicative, and action-oriented; classify content that belongs in commands, onboarding, reference docs…

perhapsspy/project-legibility · 85 tokens