Skip to content

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.

  • Git
  • A project directory to work in
  • An AI assistant (Claude Code, Cursor, GitHub Copilot, etc.)
Terminal window
git clone https://github.com/ydun-code-library/Ydun_ai_workflow.git

Keep this clone alongside your projects — you’ll use it for version checks, sync tools, and documentation standards.

The minimum viable setup is three files:

Terminal window
# From wherever you cloned the repo:
cd Ydun_ai_workflow
# Required
cp templates/core/AGENTS.md.template /path/to/your-project/AGENTS.md
cp templates/core/CLAUDE.md.template /path/to/your-project/CLAUDE.md
cp templates/core/JIMMYS-WORKFLOW.md /path/to/your-project/
# Recommended (session continuity)
cp templates/core/STATUS.md.template /path/to/your-project/STATUS.md
cp templates/core/NEXT-SESSION-START-HERE.md.template /path/to/your-project/NEXT-SESSION-START-HERE.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:

SectionWhat to write
IMPORTANT_CONTEXTBackground your AI needs to know
SERVICE_OVERVIEWArchitecture and component descriptions
CURRENT_STATUSWhat works, what doesn’t, what’s in progress
KNOWN_ISSUESBugs and limitations
PROJECT_SPECIFIC_GUIDELINESRules specific to your project
COMMON_PATTERNSCode patterns your project uses
DEPENDENCIESExternal services, APIs, databases
ENVIRONMENT_VARIABLESRequired env vars with descriptions
TROUBLESHOOTINGCommon problems and solutions

For a full walkthrough of every section, see the AGENTS Template Guide and Initializing a Project.

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

Check for unfilled placeholders:

Terminal window
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.

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.

Templates are versioned. From your Ydun_ai_workflow clone, check if your project’s templates match the latest:

Terminal window
cd Ydun_ai_workflow
git pull # Get latest templates
templates/tools/check-version.sh # Compare against your project

To sync updates while preserving your customizations:

Terminal window
templates/tools/sync-templates.sh --dry-run # Preview changes
templates/tools/sync-templates.sh # Apply with confirmation