bootstrap-project
Original:🇺🇸 English
Translated
Scaffolds per-project agent context — creates a tailored AGENTS.md, a CLAUDE.md symlink, and an agent_docs/ directory so AI agents can work effectively in the repository.
17installs
Sourcekylelundstedt/dotfiles
Added on
NPX Install
npx skill4agent add kylelundstedt/dotfiles bootstrap-projectTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Bootstrap Project
Set up agent context files so Claude Code, Codex, and other AI agents understand a project from the first prompt.
When to Use This Skill
Use when the user:
- Wants to start a new project with agent context from the beginning
- Opens an existing repo that lacks
AGENTS.md - Says "bootstrap this project", "set up agent context", or similar
- Asks for help creating or
CLAUDE.mdAGENTS.md
Steps
1. Determine whether this is a new or existing project
Existing project — the current directory has source files, a README, or a directory:
.git- Skip to step 3.
New project — the current directory is not a project, or the user wants to create one:
- Ask for:
- Project name — used for the directory name (kebab-case, e.g. ) and the
my-projectheading.AGENTS.md - Location — parent directory (default: current directory).
- Brief description — purpose, intended stack, key constraints. This replaces file-based inference in step 3.
- Project name — used for the directory name (kebab-case, e.g.
- Create the directory:
mkdir -p <location>/<project-name> - into it.
cd - Run .
git init - Create a appropriate for the described stack (e.g. Node, Python, Rust).
.gitignore
2. Guard against overwrites
- If already exists, stop and ask before overwriting.
AGENTS.md - If exists and is not a symlink to
CLAUDE.md, stop and ask.AGENTS.md - If already exists, skip creating it but mention it.
agent_docs/
3. Gather project context
Read (do not modify) the following if they exist:
- /
README.mdREADME - ,
package.json,pyproject.toml,Cargo.toml, or equivalent manifestgo.mod - Top-level directory listing (one level deep)
- CI config (,
.github/workflows/,.gitlab-ci.yml,Makefile, etc.)Justfile
For new projects with no files, use the user's description from step 1 instead.
4. Write AGENTS.md
AGENTS.mdCreate in the project root. Use the structure below as a guide — fill every section with specifics from step 3. Omit sections that don't apply. Never leave placeholder text or angle-bracket tokens in the output.
AGENTS.mdStructure:
- Heading — project name.
- Opening line — one-sentence purpose.
- Stack — language, framework, major dependencies.
- Directory Structure — table of key paths and their purpose.
- Key Commands — build, test, lint/format, dev server (only those that exist).
- Conventions — coding style, naming, branching model, PR process.
- Gotchas — non-obvious things an agent should know (env vars, generated files, monorepo quirks, etc.).
5. Create CLAUDE.md
symlink
CLAUDE.mdbash
ln -s AGENTS.md CLAUDE.mdClaude Code reads for project instructions. The symlink keeps as the single source of truth. Codex reads directly — no extra symlink needed.
CLAUDE.mdAGENTS.mdAGENTS.md6. Create agent_docs/
directory
agent_docs/bash
mkdir -p agent_docsAdd so the directory is tracked by git:
agent_docs/README.mdmarkdown
# agent_docs
Supplementary context for AI agents working in this repository.
Place architecture decisions, API specs, or onboarding notes here.7. Report results
Print a summary of what was created:
Created:
AGENTS.md — project context for AI agents
CLAUDE.md -> AGENTS.md (symlink)
agent_docs/ — supplementary context directory
Next steps:
- Review AGENTS.md and refine any sections
- Add architecture docs or API specs to agent_docs/
- Commit the new files