{"id":50701324,"url":"https://github.com/bence-toth/create-ai-agents-docs","last_synced_at":"2026-06-09T09:03:11.932Z","repository":{"id":359872514,"uuid":"1246592197","full_name":"bence-toth/create-ai-agents-docs","owner":"bence-toth","description":"A simple CLI tool to bootstrap structured documentation templates for AI agents","archived":false,"fork":false,"pushed_at":"2026-05-23T21:08:37.000Z","size":173,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-23T22:22:18.866Z","etag":null,"topics":["agentic-ai","ai-agents","ai-instructions","documentation","instructions"],"latest_commit_sha":null,"homepage":"https://bence-toth.github.io/create-ai-agents-docs/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bence-toth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-05-22T10:52:06.000Z","updated_at":"2026-05-23T21:08:26.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/bence-toth/create-ai-agents-docs","commit_stats":null,"previous_names":["bence-toth/create-ai-agents-docs"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/bence-toth/create-ai-agents-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bence-toth%2Fcreate-ai-agents-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bence-toth%2Fcreate-ai-agents-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bence-toth%2Fcreate-ai-agents-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bence-toth%2Fcreate-ai-agents-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bence-toth","download_url":"https://codeload.github.com/bence-toth/create-ai-agents-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bence-toth%2Fcreate-ai-agents-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34098952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agentic-ai","ai-agents","ai-instructions","documentation","instructions"],"created_at":"2026-06-09T09:03:11.087Z","updated_at":"2026-06-09T09:03:11.913Z","avatar_url":"https://github.com/bence-toth.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# create-ai-agents-docs\n\nScaffold AI agent-friendly documentation into any repository with a single command.\n\n## Usage\n\n```sh\nnpx create-ai-agents-docs\n```\n\nThis runs in interactive mode and guides you through template selection and output directory.\n\n### Non-interactive\n\n```sh\n# Use the built-in default template\nnpx create-ai-agents-docs --template default\n\n# Use a template from a GitHub repository\nnpx create-ai-agents-docs --template https://github.com/some-org/some-repo\n\n# Use a template from a local path\nnpx create-ai-agents-docs --template ./my-custom-template\n\n# Specify the output directory (defaults to current directory)\nnpx create-ai-agents-docs --output ./my-project\n```\n\n### Flags\n\n| Flag         | Description                              | Default     |\n| ------------ | ---------------------------------------- | ----------- |\n| `--template` | Template name, GitHub URL, or local path | `default`   |\n| `--output`   | Directory to scaffold files into         | current dir |\n| `--force`    | Overwrite existing files                 | `false`     |\n| `--help`     | Show usage information                   |             |\n| `--version`  | Show version number                      |             |\n\n## Built-in templates\n\n### `default`\n\nA comprehensive starter for AI agent-friendly documentation. Includes:\n\n- `AGENTS.md` — instructions and context for AI agents working in the repository\n- `CLAUDE.md` — symlink to `AGENTS.md` (Claude Code)\n- `.cursorrules` — symlink to `AGENTS.md` (Cursor)\n- `.windsurfrules` — symlink to `AGENTS.md` (Windsurf)\n- `.clinerules` — symlink to `AGENTS.md` (Cline)\n- `GEMINI.md` — symlink to `AGENTS.md` (Gemini CLI)\n- `.github/copilot-instructions.md` — symlink to `AGENTS.md` (GitHub Copilot)\n- `CONTRIBUTING.md` — contribution guidelines\n- `docs/GLOSSARY.md` — project terminology\n- `docs/architecture/README.md` — architecture overview\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n\n### `microservices`\n\nFor distributed systems composed of multiple independently deployable services. Prompts for project name and communication pattern (REST/gRPC/events/mixed). Includes:\n\n- `AGENTS.md` — service map, data ownership rules, inter-service communication patterns, cross-service change rollout process, observability requirements\n- `CONTRIBUTING.md` — microservices contribution workflow including contract change coordination\n- `docs/contracts/README.md` — API and event contract documentation templates with versioning guidance\n- `docs/GLOSSARY.md` — distributed systems terminology (bounded context, correlation ID, idempotent, saga, service contract)\n- `docs/architecture/README.md` — service map, data ownership, communication patterns, observability stack\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `cli`\n\nFor command-line tools and developer utilities written in TypeScript, Go, Rust, or Python. Prompts for project name and language. Includes:\n\n- `AGENTS.md` — command/subcommand structure, stdout vs. stderr conventions, exit code rules, configuration resolution order, how to add a new command\n- `CONTRIBUTING.md` — CLI contribution workflow including output behavior verification\n- `docs/commands/README.md` — command reference template with flags, arguments, and exit codes\n- `docs/GLOSSARY.md` — CLI terminology (command, subcommand, flag, argument, stdout, stderr, exit code)\n- `docs/architecture/README.md` — command tree, argument parsing, configuration resolution, plugin system\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `fullstack`\n\nFor full-stack web applications with a frontend, backend, and database in one repository. Prompts for project name, frontend framework, and backend language. Includes:\n\n- `AGENTS.md` — client/server boundary rules, shared code conventions, API contract discipline, environment variable safety, database migration workflow\n- `CONTRIBUTING.md` — full-stack contribution workflow including cross-layer change guidance\n- `docs/GLOSSARY.md` — full-stack terminology (client, server, shared, API contract)\n- `docs/architecture/README.md` — system diagram, auth flow, data fetching strategy, state management, database\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `design-system`\n\nFor component libraries and design systems built with React, Vue, Web Components, or Svelte. Prompts for project name and framework. Includes:\n\n- `AGENTS.md` — component authoring guidelines, WCAG 2.1 AA accessibility requirements, design token rules, Storybook story requirements, visual regression testing\n- `CONTRIBUTING.md` — design system contribution workflow including an accessibility checklist\n- `docs/components/README.md` — component inventory with status tracking (Stable/Beta/Deprecated)\n- `docs/GLOSSARY.md` — design system terminology (tokens, variants, slots, visual regression)\n- `docs/architecture/README.md` — token hierarchy, component composition model, theming, component categories\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `data-pipeline`\n\nFor data engineering projects — ETL/ELT pipelines, data warehouses, dbt, Airflow, Dagster, or Spark. Prompts for project name, orchestrator, and transformation tool. Includes:\n\n- `AGENTS.md` — idempotency rules, backfill guidance, data quality requirements, schema change process, pipeline conventions\n- `CONTRIBUTING.md` — data pipeline contribution workflow including backfill and schema change documentation\n- `docs/GLOSSARY.md` — data engineering terminology (DAG, backfill, idempotent, raw/staging/mart layers)\n- `docs/architecture/README.md` — data flow diagram, source systems, pipeline inventory, data quality strategy\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `infrastructure`\n\nFor Infrastructure-as-Code projects — Terraform, Pulumi, CloudFormation, or Kubernetes. Prompts for project name and IaC tool. Includes:\n\n- `AGENTS.md` — plan-before-apply workflow, environment hierarchy (dev/staging/prod), state management rules, naming conventions, blast radius awareness\n- `CONTRIBUTING.md` — IaC contribution workflow including staged rollout and peer review requirements\n- `docs/GLOSSARY.md` — infrastructure terminology (blast radius, drift, idempotent, plan, state)\n- `docs/architecture/README.md` — environment topology, network layout, compute resources, IAM, secrets management\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `mobile`\n\nFor mobile applications built with React Native, Flutter, SwiftUI, or Kotlin. Prompts for project name and framework. Includes:\n\n- `AGENTS.md` — platform-specific guidance (iOS/Android), build commands, simulator/emulator setup, navigation structure, platform-conditional code patterns\n- `CONTRIBUTING.md` — mobile contribution workflow including cross-platform testing requirements\n- `docs/GLOSSARY.md` — mobile terminology (bridge, native module, simulator, emulator)\n- `docs/architecture/README.md` — navigation structure, state management, data fetching, native modules\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `library`\n\nFor reusable packages published to a registry (npm, PyPI, crates.io, Maven). Prompts for package name and registry. Includes:\n\n- `AGENTS.md` — public API rules, semantic versioning policy, deprecation process, how to add a new feature without breaking changes\n- `CONTRIBUTING.md` — library contribution workflow including breaking change guidance\n- `docs/api/README.md` — public API reference template\n- `docs/GLOSSARY.md` — library terminology (public API, consumer, breaking change)\n- `docs/architecture/README.md` — module structure, public vs. internal, extension points\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `api-service`\n\nFor backend API services — REST or GraphQL, with a database, auth, and deployment. Prompts for project name and API style. Includes:\n\n- `AGENTS.md` — API conventions, request validation rules, auth patterns, database migration workflow, how to add a new endpoint\n- `CONTRIBUTING.md` — API-focused contribution workflow including migration guidance\n- `docs/api/README.md` — endpoint documentation template\n- `docs/GLOSSARY.md` — project terminology\n- `docs/architecture/README.md` — request lifecycle, service layers, data model, auth\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `python`\n\nFor Python projects — web apps (Django, Flask, FastAPI), scripts, data science, or libraries. Prompts for project name and package manager (pip/poetry/uv). Includes:\n\n- `AGENTS.md` — virtual environment setup, pytest usage, ruff/mypy workflow, type annotation and import style rules\n- `CONTRIBUTING.md` — Python-specific contribution workflow including the full check suite\n- `docs/GLOSSARY.md` — project terminology\n- `docs/architecture/README.md` — architecture overview\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n### `monorepo`\n\nFor multi-package workspaces managed with Nx, Turborepo, pnpm workspaces, npm workspaces, or Yarn workspaces. Prompts for project name and workspace tool. Includes:\n\n- `AGENTS.md` — workspace map, package boundary rules, how to run commands at workspace root vs. package level, and how to add new packages\n- `CONTRIBUTING.md` — monorepo contribution workflow, cross-package change guidance\n- `docs/GLOSSARY.md` — workspace terminology (app, package, root, workspace)\n- `docs/architecture/README.md` — package dependency graph, shared packages, deployment units\n- `docs/adr/adr-template.md` — Architecture Decision Record template\n- `.claude/settings.json` — Claude Code configuration\n- Agent symlinks (CLAUDE.md, .cursorrules, .windsurfrules, .clinerules, GEMINI.md, .github/copilot-instructions.md)\n\n## External templates\n\nPoint `--template` at any GitHub repository or local directory that follows the template structure. GitHub repositories are cloned with `git clone --depth 1`; local paths are used directly.\n\n```sh\nnpx create-ai-agents-docs --template https://github.com/org/my-template\nnpx create-ai-agents-docs --template ./path/to/my-template\nnpx create-ai-agents-docs --template /absolute/path/to/my-template\n```\n\n## Template authoring\n\nTo build a custom template, use the [create-ai-agents-docs-template](https://github.com/bence-toth/create-ai-agents-docs-template) starter kit — it contains the default template's files as a starting point.\n\nA template is a directory of files to scaffold. Any files in the directory are copied to the target when the template is applied.\n\n### Template structure\n\n```\nmy-template/\n├── template.json   # optional config (not copied to target)\n├── AGENTS.md\n├── CONTRIBUTING.md\n└── docs/\n    └── GLOSSARY.md\n```\n\n### template.json\n\nTemplates may include a `template.json` at their root to configure variables, post-copy hooks, and ignored files. All fields are optional.\n\n```json\n{\n  \"name\": \"My Custom Template\",\n  \"description\": \"A short description shown in interactive mode\",\n  \"variables\": {\n    \"projectName\": {\n      \"prompt\": \"What is your project name?\",\n      \"default\": \"my-project\"\n    },\n    \"author\": {\n      \"prompt\": \"Author name?\"\n    }\n  },\n  \"hooks\": {\n    \"postCopy\": \"echo 'Done! Run npm install to get started.'\"\n  },\n  \"ignore\": [\"README-template.md\"]\n}\n```\n\n#### Variables\n\nVariables prompt the user for values and substitute `{{variableName}}` placeholders in file contents.\n\n```md\n# {{projectName}}\n\nMaintained by {{author}}.\n```\n\nIf a variable has a `default`, it is used when the user presses Enter without typing a value.\n\n#### Post-copy hooks\n\n`hooks.postCopy` is a shell command (or semicolon-separated commands) run in the target directory after files are copied.\n\n#### Ignore list\n\n`ignore` is a list of file paths relative to the template root that should not be copied to the target. `template.json` is always excluded automatically.\n\n### Tips\n\n- Keep templates focused. A template should scaffold a specific kind of project, not try to cover every use case.\n- Use `{{variableName}}` placeholders for values that differ between projects (project name, author, etc.).\n- The `description` field in `template.json` is shown in interactive mode — keep it under 60 characters.\n- Test your template locally before publishing: `npx create-ai-agents-docs --template ./my-template --output /tmp/test-output`\n\n## License\n\n[Licensed under MIT.](https://github.com/bence-toth/create-ai-agents-docs/blob/main/LICENSE) Do what you will.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbence-toth%2Fcreate-ai-agents-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbence-toth%2Fcreate-ai-agents-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbence-toth%2Fcreate-ai-agents-docs/lists"}