init-project-doc

A rule that creates a project documentation file, such as CLAUDE.md or AGENTS.md, from a project's folder structure and source code.

In plain words
What is it for?
Use it to initialize project documentation, identify the main language and framework, and prepare information for a personal portfolio.
Why use it?
It gives a project a consistent summary instead of requiring its architecture and technologies to be documented by hand.

Cursor rule

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 rules/jasonchen0604/codebase-to-portfolio/init-project-doc
Clone the repo
git clone --depth 1 https://github.com/jasonChen0604/codebase-to-portfolio
Per session 75 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,591 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.00075 $0.01591
Opus 5 $0.00037 $0.00796
Sonnet 5 $0.00015 $0.00318
Haiku 4.5 $0.00007 $0.00159

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

Security

Grade A, and why

init-project-doc 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.

adapters/cursor/init-project-doc.mdc · 112 lines

How it starts

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

Init Project Doc Skill

Role

You are a senior software architect and personal-brand consultant. The goal is to inventory a software project so it can feed an automated personal portfolio site and resume/LinkedIn sync.

Trigger

The user provides a project's directory tree and/or core source snippets, and asks for a project doc to be generated.

Execution Steps

Step 0: Read config

Read profile.config.json from the current working directory. If missing, tell the user to copy examples/profile.config.example.json to profile.config.json and fill it in, then stop.

  • doc_filename (default CLAUDE.md) — the output filename
  • languages (default ["en"]) — output language(s) for descriptive text
  • timezone (default +00:00) — used for the generated_at timestamp

Step 1: Read reference files

Read the following files, located in this skill's directory:

  • config.jsonallowed_categories and allowed_statuses lists
  • template.md → output format (with YAML frontmatter) and all {{VARIABLE}} fields

Step 2: Analyze project code

From the user-provided tree structure and source code, identify:

  • Core language & framework (e.g. TypeScript + Next.js, Python + FastAPI)
  • Database / storage layer (e.g. PostgreSQL, Redis, SQLite)
  • Build tools / package manager (e.g. pnpm, Poetry, Gradle)
  • Deployment / cloud services (e.g. Vercel, Docker, AWS Lambda)
  • Key feature highlights (inferred from directory structure and code logic)
  • Technical challenges (default to "None (fill in manually)" if not evident)
  • Architecture patterns (e.g. MVC, Repository Pattern, Event-Driven)
  • State management (e.g. Zustand, Redux, Context API, none)
  • Auth / authorization mechanism (e.g. NextAuth, JWT, OAuth, none)

Step 3: Apply constraints

  • category: must exactly match one item from allowed_categories — do not invent new ones
  • status: must exactly match one item from allowed_statuses — do not invent new ones
  • featured: always false
  • github_repo_name: inferred from the project directory name (empty string if unclear)
  • cover_image: always empty string ""

Read the full file on GitHub · 112 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 · 112 lines · 75 tokens per session scan A 6688949c002a

Subscribe to this mod's changes

init-project-doc is a cursor rule published in the GitHub repository jasonChen0604/codebase-to-portfolio (2 stars, last pushed 1mo ago), licensed MIT. It adds 75 tokens to every session and 1,591 once invoked, about $0.0004 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-31.