skills.rest
huangwb8
huangwb8COMMUNITY
Explore all skills by this author →
WebsiteGitHub

init-project

Generate AGENTS.md, CLAUDE.md, README.md, and CHANGELOG.md for new projects.

47|8|Updated Jan 3, 2026
Search Tags:#multiplatform#init-project#markdown-templates#project-documentation#ai-doc-generation
One-click install
npx skills add https://github.com/huangwb8/skills --skill init-project-huangwb8
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: init-project
Source: https://github.com/huangwb8/skills/tree/main/init-project
Command: npx skills add https://github.com/huangwb8/skills --skill init-project-huangwb8

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, and includes scripts (resource) components.

What problem does it solve?

Automates generation of cross‑platform AI project instruction documents (AGENTS.md, CLAUDE.md, README.md, CHANGELOG.md) from an existing codebase, reducing manual setup effort.

Core Features & Use Cases

  • Detects project type (Python/Web/Rust/Go/Java/data-science/docs) and language
  • Generates AGENTS.md (cross-platform core) and CLAUDE.md via @./AGENTS.md
  • Generates README.md and CHANGELOG.md; supports smart merge preserving user customizations

Quick Start

Run the auto generator at the project root to produce CLAUDE.md, AGENTS.md, README.md and CHANGELOG.md.

Frequently Asked Questions about init-project

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate AI project instruction documents like AGENTS.md and CLAUDE.md?▼

To generate AI project instruction documents automatically, run the project initializer at your repository root. It analyzes the codebase, infers the project type, and outputs AGENTS.md and CLAUDE.md to bootstrap your project.

What is a cross-platform AGENTS.md file and how does it relate to CLAUDE.md?▼

A cross-platform AGENTS.md file serves as the core AI instruction document for a repository. The tool generates CLAUDE.md that references AGENTS.md via the @./AGENTS.md import syntax to ensure synchronization across platforms.

Can I automatically generate README.md and CHANGELOG.md for a Python or Rust project?▼

Yes, the generator detects Python, Rust, Web, Go, Java, data-science, and docs project types. It automatically renders README.md and CHANGELOG.md templates based on the inferred language and repository structure.

How do I update standard project documentation sections without overwriting my custom content?▼

To update standard documentation sections without losing custom content, the generator uses a smart merge workflow. It preserves your user customizations while updating standard sections in AGENTS.md and README.md.

Do I need PyYAML installed to bootstrap project documentation files?▼

Yes, PyYAML is a required dependency for running the documentation generation scripts. You must have it installed in your Python environment before executing the project initializer.

What are the limitations of automated language detection for documentation generation?▼

Automated language detection is limited to Python, Web, Rust, Go, Java, data-science, and docs repositories. Projects outside these categories may not be accurately inferred, affecting the generated template structure.

Related Skills

Explore More Software Engineering Skills→
cryborg1211cryborg1211

vc:docs

Analyze codebases to generate and maintain structured project documentation.

Community
Intermediate
CaltexBevoCaltexBevo

document-release

Update core documentation files to reflect shipped code changes.

Community
Advanced
erclxerclx
2

aitk-snippets

Manage markdown prompt snippets across projects with the aitk CLI.

Community
Intermediate
raulbethencourtraulbethencourt
2

translation

Translate Markdown files while preserving code blocks and front-matter.

Community
Intermediate