Skip to content
Development
Skill

/init-project

Initialize project AI context, generate/update root-level and module-level CLAUDE.md indexes

From plugin
zcf
6.1k12 skills1 agent

Claude Code

$ npx -y skills add UfoMiao/zcf --skill init-project --agent claude-code

SKILL.md

init-project.SKILL.md
name: init-project
description: Initialize project AI context, generate/update root-level and module-level CLAUDE.md indexes
disable-model-invocation: true
allowed-tools: Read(**), Write(CLAUDE.md, **/CLAUDE.md)

Usage

`/init-project <PROJECT_SUMMARY_OR_NAME>`

Objective

Initialize project AI context using a mixed strategy of "concise at root + detailed at module level":

  • Generate/update `CLAUDE.md` at repository root (high-level vision, architecture overview, module index, global standards).
  • Generate/update local `CLAUDE.md` in identified module directories (interfaces, dependencies, entry points, tests, key files, etc.).
  • ✨ **For improved readability, automatically generate Mermaid structure diagrams in the root `CLAUDE.md` and add navigation breadcrumbs to each module `CLAUDE.md`**.

Orchestration Instructions

**Step 1**: Call the `get-current-datetime` sub-agent to obtain the current timestamp.

**Step 2**: Call the `init-architect` sub-agent once, with input:

  • `project_summary`: $ARGUMENTS
  • `current_timestamp`: (timestamp from step 1)

Execution Strategy (Agent adapts automatically, no user parameters needed)

  • **Stage A: Repository Census (Lightweight)**

Quickly count files and directories, identify module roots (package.json, pyproject.toml, go.mod, apps/_, packages/_, services/\*, etc.).

  • **Stage B: Module Priority Scanning (Medium)**

For each module, perform targeted reading and sampling of "entry/interfaces/dependencies/tests/data models/quality tools".

  • **Stage C: Deep Supplementation (As Needed)**

If repository is small or module scale is small, expand reading scope; if large, perform batch supplemental scanning on high-risk/high-value paths.

  • **Coverage Measurement and Resumability**

Output "scanned files / estimated total files, covered module ratio, ignored/skipped reasons" and list "recommended next-step deep-dive sub-paths". When running `/init-project` repeatedly, perform **incremental updates** and **breakpoint resumable scanning** based on previous index.

Security and Boundaries

  • Only read/write documentation and indexes, do not modify source code.
  • Ignore common generated artifacts and binary large files by default.
  • Print "summary" in main dialog, write full content to repository.

Output Requirements

  • Print "Initialization Result Summary" in main dialog, including:
  • Whether root-level `CLAUDE.md` was created/updated, major section overview.
  • Number of identified modules and their path list.
  • Generation/update status of each module's `CLAUDE.md`.
  • ✨ **Explicitly mention "Generated Mermaid structure diagram" and "Added navigation breadcrumbs for N modules"**.
  • Coverage and major gaps.
  • If not fully read: explain "why stopped here" and list **recommended next steps** (e.g., "suggest priority supplemental scanning: packages/auth/src/controllers").
Read more
@ufomiao
Ships withzcf

Zero-Config Code Flow for Claude code & Codex

6.1k12 skills1 agent
Get the whole plugin

Stars on GitHub

Momentum

stars in total
6.1k
Star history of UfoMiao/zcf on GitHub, a chart by star-history.com

Other skills on zcf.

zcf-add-sponsor

zcf-add-sponsor

Quickly add a new corporate sponsor to ZCF — sponsor list by default, with optional API preset and documentation ad placements

@ufomiao@ufomiaoInstall Skill
zcf-pr

zcf-pr

Create a pull request for the current branch with a description based on the project PR template

@ufomiao@ufomiaoInstall Skill
zcf-release

zcf-release

Prepare a ZCF release with changesets, a bilingual changelog, a release branch and a pull request

@ufomiao@ufomiaoInstall Skill
zcf-update-docs

zcf-update-docs

Bring docs/ (en, zh-CN, ja-JP) and AGENTS.md in line with code changes since the last release tag

@ufomiao@ufomiaoInstall 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 init-project.

Which coding agents can use init-project?
init-project 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.