Skip to content
Development
Skill

/gen-claudemd

Regenerate the nyann-managed block in CLAUDE.md from the current profile, stack detection, and doc plan — without re-running a full bootstrap or retrofit. TRIGGER when the user says "regenerate CLAUDE.md", "update CLAUDE.md", "refresh CLAUDE.md", "rebuild CLAUDE.md", "re-gen

From plugin
nyann
741 skills41 commands3 hooks

Claude Code

$ npx -y skills add thettwe/nyann --skill gen-claudemd --agent claude-code

SKILL.md

gen-claudemd.SKILL.md
name: gen-claudemd
description: >
  Regenerate the nyann-managed block in CLAUDE.md from the current profile,
  stack detection, and doc plan — without re-running a full bootstrap or
  retrofit. TRIGGER when the user says "regenerate CLAUDE.md",
  "update CLAUDE.md", "refresh CLAUDE.md", "rebuild CLAUDE.md",
  "re-gen CLAUDE.md", "my CLAUDE.md is stale", "CLAUDE.md doesn't match
  my profile", "sync CLAUDE.md with the profile", "/nyann:gen-claudemd".
  Do NOT trigger on "optimize CLAUDE.md" / "trim CLAUDE.md" / "what's
  unused" — that's the `optimize-claudemd` skill (usage-analytics-driven).
  Do NOT trigger on "explain CLAUDE.md" / "what's in CLAUDE.md" — that's
  `explain-state`. Do NOT trigger on initial project setup — that's
  `bootstrap-project`.

gen-claudemd

Standalone CLAUDE.md regeneration. Wraps `bin/gen-claudemd.sh` with the same inputs bootstrap uses, but skips the full bootstrap pipeline so the user can refresh CLAUDE.md after changing their profile, adding docs, or restructuring workspaces.

1. Gather inputs

The generator needs three inputs. Resolve them in this order:

1. **Profile** — resolve the active profile via preferences or CLAUDE.md markers; load with `bin/load-profile.sh <name>`. If the user names a specific profile, use that instead. 2. **Doc plan** — the generator needs a DocumentationPlan. To preserve the repo's existing doc routing (local / Obsidian / Notion / split), re-derive the plan using the same routing the user originally chose. Check `profile.documentation.storage_strategy`; if it names a non-local backend, also run `bin/detect-mcp-docs.sh` and pass `--mcp-targets` to route-docs. For local-only repos (the common case): `bin/route-docs.sh --profile <profile-path>` suffices. Write the resulting DocumentationPlan JSON to a temp file. 3. **Stack** (optional but recommended) — run `bin/detect-stack.sh --path .` for a StackDescriptor JSON. Write it to a temp file. Skip if detection fails (gen-claudemd falls back to profile-only data).

For monorepos, also resolve workspace configs:

bin/resolve-workspace-configs.sh --stack <stack-path> --profile <profile-path>

Pass the result via `--workspace-configs <path>`.

2. Snapshot the current state

Before running the generator, capture the existing managed block so you can show a before/after diff. If CLAUDE.md exists with markers, read the content between `<!-- nyann:start -->` and `<!-- nyann:end -->`. If no markers exist, note that a new block will be appended.

3. Confirm before writing

Ask: "Regenerate the nyann-managed block in CLAUDE.md?"

Show what will feed into the generation (profile name, stack, storage strategy) so the user can verify the inputs are correct. Skip the confirmation only when the user said "just do it".

4. Run the generator

On confirmation:

bin/gen-claudemd.sh \
  --profile <profile-path> \
  --doc-plan <doc-plan-path> \
  [--stack <stack-path>] \
  [--workspace-configs <ws-path>] \
  [--project-name <name>] \
  --target <cwd>

The script writes CLAUDE.md in-place — content outside markers is preserved verbatim.

If the script warns about the 3 KB soft cap, relay the warning and suggest `/nyann:optimize-claudemd` as a follow-up.

If the script refuses at the 8 KB hard cap, explain and offer `--force` to override.

5. Report

  • Before/after diff of the managed block.
  • Byte count of the managed block.
  • Whether user content outside markers was preserved (always yes).

When to hand off

  • "Optimize CLAUDE.md based on usage" → `optimize-claudemd` skill.
  • "What does nyann see in this repo?" → `explain-state` skill.
  • "Check if my repo is healthy" → `doctor` skill.
  • "Switch to a different profile" → `migrate-profile` skill

(which calls gen-claudemd internally after the switch).

Read more
@thettwe
Ships withnyann

ငြမ်း is Burmese for scaffolding. Nyann is the Claude Code plugin that picks expert git defaults for your stack — branching, working hooks (Husky / pre-commit.com / lefthook), commits, releases, CI, docs — then keeps the repo on those rails through every PR

Stars on GitHub

Momentum

stars in total
7
Star history of thettwe/nyann on GitHub, a chart by star-history.com

Other skills on nyann.

add-team-source

add-team-source

Register a git URL as a team-profile source so nyann can periodically sync and expose its profiles under a namespace. TRIGGER…

@thettwe@thettweInstall Skill
bootstrap-project

bootstrap-project

Bootstrap a fresh or existing repo with nyann. TRIGGER when the user says "set up this project", "initialize git workflow",…

@thettwe@thettweInstall Skill
check-prereqs

check-prereqs

Survey the machine and report which nyann features are usable right now. TRIGGER when the user says "is my machine ready for…

@thettwe@thettweInstall Skill
cleanup-branches

cleanup-branches

Prune local branches whose work is already merged into the base. TRIGGER when the user says "clean up branches", "delete merged…

@thettwe@thettweInstall Skill
commit

commit

Generate a Conventional Commits message from the staged diff and create the commit after user confirmation. TRIGGER when the user…

@thettwe@thettweInstall Skill
diagnose

diagnose

Bundle a redacted, support-grade snapshot of the current nyann state for inclusion in a bug report or support request. Combines…

@thettwe@thettweInstall Skill

More skills from other plugins.

brainstorming
Auto-invoked

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or…

@obra@obraInstall Skill
ask-matt

ask-matt

Ask which skill or flow fits your situation. A router over the skills in this repo.

skills2w309k
@mattpocock@mattpocockInstall Skill
accessibility
Auto-invoked

accessibility

Design, implement, and audit accessible UI to WCAG 2.2 Level AA across Web, iOS, and Android — semantic ARIA roles and labels,…

ecc2w293k
@affaan-m@affaan-mInstall Skill
compiler-commit

compiler-commit

Use when you want to verify compiler changes and commit with the correct convention. Runs tests, lint, and format, then commits…

react5d252k
@facebook@facebookInstall Skill

Questions about gen-claudemd.

Which coding agents can use gen-claudemd?
gen-claudemd installs in Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, OpenCode and Windsurf with the skills CLI, using each agent's flag shown on this page. Flowy's auto-invocation, which fires a skill when your prompt matches, runs in Claude Code only.