agentleFS
itsryanarmaniitsryanarmani/skills/init-project/SKILL.md

init-project

Skill1 starsChanged 4 days agoMITView on GitHub

Auto-generate a CLAUDE.md for a new project by analyzing its structure, tooling, and conventions

49 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use addskill, apply-firmware and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • ryanportfolioSkill

    addskill

    Create, import, update, or install repo or personal skills: runtime ownership, resources, discovery checks.

    Also in 6 projects that use this

  • ryanportfolioSkill

    apply-firmware

    Bring current folder (plain folder, existing repo, old or partial firmware copy) up to full Harness Firmware in place. Mirror external repo → adopt-repo.

    Also in 6 projects that use this

  • +10 more from ryanportfolio

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 41 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check for these files to determine the technology stack:

    line 15
  2. Distinctive:

    Write a CLAUDE.md file with these sections:

    line 71
  3. Distinctive:

    Keep it under 200 lines — it's always in context

    line 112
  4. Distinctive:

    Update it when project conventions change

    line 114

“Common” is measured: kept by at least 6 in 10 of the 41 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Init Project — CLAUDE.md Generator

Analyze the current project and generate a tailored CLAUDE.md file with project instructions for Claude Code.

Steps

1. Detect project type

Check for these files to determine the technology stack:

FileStack
package.jsonNode.js / JavaScript / TypeScript
Cargo.tomlRust
go.modGo
pyproject.toml / setup.pyPython
GemfileRuby
pom.xml / build.gradleJava / Kotlin

2. Analyze project structure

# Show directory tree (2 levels deep, ignore node_modules etc.)
find . -maxdepth 2 -type d \
  -not -path '*/node_modules/*' \
  -not -path '*/.git/*' \
  -not -path '*/dist/*' \
  -not -path '*/build/*' \
  -not -path '*/.next/*' \
  | head -40

3. Extract tooling configuration

Read and analyze:

  • Linter config: .eslintrc*, ruff.toml, .rubocop.yml, clippy.toml
  • Formatter config: .prettierrc*, rustfmt.toml, black config
  • TypeScript config: tsconfig.json (strictness settings)
  • Test config: vitest.config.*, jest.config.*, pytest.ini, Cargo.toml [test]
  • CI config: .github/workflows/*.yml, .gitlab-ci.yml
  • Build scripts: package.json scripts, Makefile, Taskfile

4. Discover available commands

For Node.js:

# List all npm scripts
node -e "const p=require('./package.json'); Object.keys(p.scripts||{}).forEach(s=>console.log(s))"

5. Check for existing conventions

Look for:

  • Existing CONTRIBUTING.md or DEVELOPMENT.md
  • Code style patterns in existing source files
  • Import ordering conventions
  • Naming patterns (camelCase, snake_case, PascalCase)
  • Error handling patterns

6. Generate CLAUDE.md

Write a CLAUDE.md file with these sections:

# [Project Name] — Claude Code Project Instructions

## Project Overview

[1-2 sentence description based on package.json/README]

## Architecture

[Directory structure with purpose of each top-level dir]

## Code Style Rules

[Extracted from linter/formatter config]

## Available Commands

[From package.json scripts or Makefile]

## CI Pipeline

[From GitHub Actions/GitLab CI config]

## Testing

[Test framework, how to run, conventions]

## Key Conventions

[Naming, imports, error handling patterns]

7. Verify

Show the generated CLAUDE.md to the user for review before writing.

Notes

  • CLAUDE.md is automatically loaded by Claude Code on every session
  • Keep it under 200 lines — it's always in context
  • Focus on rules and conventions, not documentation
  • Update it when project conventions change

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.