Installation
Setting up Ydun AI Workflow takes about 10 minutes. You clone the templates repo, copy a few files into your project, and fill in the placeholders.
Prerequisites
Section titled “Prerequisites”- Git
- A project directory to work in
- An AI assistant (Claude Code, Cursor, GitHub Copilot, etc.)
Step 1: Clone the templates
Section titled “Step 1: Clone the templates”git clone https://github.com/ydun-code-library/Ydun_ai_workflow.gitKeep this clone alongside your projects — you’ll use it for version checks, sync tools, and documentation standards.
Step 2: Copy templates into your project
Section titled “Step 2: Copy templates into your project”The minimum viable setup is three files:
# From wherever you cloned the repo:cd Ydun_ai_workflow
# Requiredcp templates/core/AGENTS.md.template /path/to/your-project/AGENTS.mdcp templates/core/CLAUDE.md.template /path/to/your-project/CLAUDE.mdcp templates/core/JIMMYS-WORKFLOW.md /path/to/your-project/
# Recommended (session continuity)cp templates/core/STATUS.md.template /path/to/your-project/STATUS.mdcp templates/core/NEXT-SESSION-START-HERE.md.template /path/to/your-project/NEXT-SESSION-START-HERE.mdStep 3: Fill in AGENTS.md
Section titled “Step 3: Fill in AGENTS.md”AGENTS.md has 9 project-specific sections marked with <!-- PROJECT_SPECIFIC START --> comments. Each needs your project’s actual context.
Key sections to fill:
| Section | What to write |
|---|---|
IMPORTANT_CONTEXT | Background your AI needs to know |
SERVICE_OVERVIEW | Architecture and component descriptions |
CURRENT_STATUS | What works, what doesn’t, what’s in progress |
KNOWN_ISSUES | Bugs and limitations |
PROJECT_SPECIFIC_GUIDELINES | Rules specific to your project |
COMMON_PATTERNS | Code patterns your project uses |
DEPENDENCIES | External services, APIs, databases |
ENVIRONMENT_VARIABLES | Required env vars with descriptions |
TROUBLESHOOTING | Common problems and solutions |
For a full walkthrough of every section, see the AGENTS Template Guide and Initializing a Project.
Step 4: Fill in CLAUDE.md
Section titled “Step 4: Fill in CLAUDE.md”CLAUDE.md is shorter — mostly command references. Fill in:
[DEV_COMMAND]— Your dev server command[TEST_COMMAND]— Your test command[BUILD_COMMAND]— Your build command[TYPECHECK_COMMAND]and[LINT_COMMAND]if applicable
Step 5: Verify
Section titled “Step 5: Verify”Check for unfilled placeholders:
grep -rn "\[.*\]" AGENTS.md | grep -v "http" | grep -v "<!-- "If this returns nothing, your templates are ready. Your AI assistants will now read AGENTS.md on entering the project and understand your context, principles, and workflow.
Using the full checklist
Section titled “Using the full checklist”For a thorough initialization with documentation standards, audit tools, and compliance checks, follow the 14-step checklist in init-project.md. It covers everything from directory setup to documentation structure.
Keeping templates updated
Section titled “Keeping templates updated”Templates are versioned. From your Ydun_ai_workflow clone, check if your project’s templates match the latest:
cd Ydun_ai_workflowgit pull # Get latest templatestemplates/tools/check-version.sh # Compare against your projectTo sync updates while preserving your customizations:
templates/tools/sync-templates.sh --dry-run # Preview changestemplates/tools/sync-templates.sh # Apply with confirmation