{"id":46277879,"url":"https://github.com/aircodelabs/llms-txt-generator","last_synced_at":"2026-03-17T23:01:18.342Z","repository":{"id":298713051,"uuid":"1000602144","full_name":"aircodelabs/llms-txt-generator","owner":"aircodelabs","description":"The ultimate AI-powered generator for llms.txt and llms-full.txt files. ","archived":false,"fork":false,"pushed_at":"2025-06-18T09:46:48.000Z","size":161,"stargazers_count":12,"open_issues_count":1,"forks_count":4,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-07T09:43:35.648Z","etag":null,"topics":["ai","ai-agent","documentation","llms","llms-txt","mcp","model-context-protocol"],"latest_commit_sha":null,"homepage":"","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/aircodelabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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}},"created_at":"2025-06-12T03:33:46.000Z","updated_at":"2026-01-15T11:37:12.000Z","dependencies_parsed_at":"2025-08-12T09:46:47.520Z","dependency_job_id":"b6e0a9d0-b7b8-431c-a61c-b7edc34711d3","html_url":"https://github.com/aircodelabs/llms-txt-generator","commit_stats":null,"previous_names":["aircodelabs/llms-txt-generator","grasplabs/llms-txt-generator","aircodelab/llms-txt-generator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aircodelabs/llms-txt-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aircodelabs%2Fllms-txt-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aircodelabs%2Fllms-txt-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aircodelabs%2Fllms-txt-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aircodelabs%2Fllms-txt-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aircodelabs","download_url":"https://codeload.github.com/aircodelabs/llms-txt-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aircodelabs%2Fllms-txt-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30635004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T22:38:22.569Z","status":"ssl_error","status_checked_at":"2026-03-17T22:38:11.804Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ai","ai-agent","documentation","llms","llms-txt","mcp","model-context-protocol"],"created_at":"2026-03-04T05:00:35.195Z","updated_at":"2026-03-17T23:01:18.337Z","avatar_url":"https://github.com/aircodelabs.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":["Agent-Readable Content"],"readme":"# llms-txt-generator\n\nThe ultimate AI-powered generator for `llms.txt` and `llms-full.txt` files. Leveraging advanced AI capabilities to create the most comprehensive and AI-optimized documentation that helps language models understand your project with unprecedented clarity and depth.\n\n## Why AI-Generated Documentation?\n\n**AI understands AI best.** Traditional documentation is written for humans, but AI models need structured, comprehensive information to truly understand your codebase. This tool leverages AI to generate documentation that:\n\n- 🧠 **Speaks AI's language** - Uses patterns and structures that AI models process most effectively\n- 🎯 **Focuses on what matters** - Highlights the information AI needs for accurate code understanding\n- 📊 **Maintains consistency** - Ensures uniform documentation format across all projects\n- ⚡ **Saves time** - Automatically generates comprehensive documentation without manual effort\n\n## Key Features\n\n- 📄 **Generate `llms.txt` files** for quick project navigation\n- 📚 **Generate `llms-full.txt` files** for comprehensive project understanding  \n- 🤖 **MCP server integration** for seamless AI assistant workflows\n- 🚀 **Simple CLI interface** with interactive setup\n- 🔧 **Flexible configuration** supporting custom output paths and formats\n\n## Quick Start\n\n### CLI Usage\n\n```bash\n# Initialize configuration file (creates llms-txt-generator.yaml)\nnpx llms-txt-generator init\n\n# Build documentation files (requires configuration)\nnpx llms-txt-generator build\n\n# Show help information\nnpx llms-txt-generator help\n\n# Auto mode: checks for config file and runs accordingly\n# - If llms-txt-generator.yaml exists: runs build\n# - If no config file: runs init then build\nnpx llms-txt-generator\n\n# Or if installed globally\nllms-txt-generator init\nllms-txt-generator build\nllms-txt-generator        # auto mode\n```\n\n#### Command Details\n\n- **`init`**: Interactive setup wizard to create `llms-txt-generator.yaml` configuration\n- **`build`**: Generate documentation files based on existing configuration\n- **`help`**: Display usage information and available commands\n- **No arguments**: Smart mode that initializes if needed, then builds documentation\n\n## Generated Files\n\n### llms.txt Structure\n\nThe generated `llms.txt` file provides a concise navigation view of your project:\n\n```markdown\n# Project Name\n\n\u003e Project introduction, briefly describing the purpose and functionality of the project.\n\n## Core Documentation\n- [Document Title](URL): Brief description\n- [Document Title](URL): Brief description\n\n## Optional Content\n- [Resource Name](URL): Brief description\n```\n\n### llms-full.txt Content\n\nThe `llms-full.txt` file contains comprehensive documentation including:\n\n- Detailed project overview\n- Core features explanation\n- Installation and usage instructions\n- Complete project structure description\n- Code examples and explanations\n- Development requirements and commands\n\nThis file is designed to give AI models a thorough understanding of your project.\n\n## MCP Integration\n\nThe llms-txt-generator includes a Model Context Protocol (MCP) server that allows AI assistants to generate documentation files directly.\n\n### Using with Cursor\n\nConfigure llms-txt-generator as an MCP tool in Cursor:\n\n1. **Add MCP Configuration**: Add the following to your Cursor settings (`cursor-settings.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"llms-generator\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"llms-txt-generator-mcp\"]\n    }\n  }\n}\n```\n\n2. **Restart Cursor** to load the new MCP configuration.\n\n3. **Use the Tool** by asking your AI assistant:\n\n```\nUse the llms-generator MCP tool to create llms.txt and llms-full.txt for this project\n```\n\n### Using with Claude Desktop\n\nFor Claude Desktop, add to your `claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"llms-generator\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"llms-txt-generator-mcp\"]\n    }\n  }\n}\n```\n\n### Available MCP Tools\n\nThe MCP server provides this tool:\n\n- **`generate-llms`**: Generate llms.txt and llms-full.txt files for the current project based on user requirements\n\n### Example Prompts\n\n```\n# Basic generation\nGenerate llms.txt and llms-full.txt files for this project\n\n# With specific requirements\nGenerate documentation files with these requirements:\n1. Output to ./docs directory\n2. Include comprehensive project details\n3. Focus on TypeScript implementation\n\n# Custom configuration\nCreate llms files with custom names: project-nav.txt and project-full.txt\n```\n\n## Development\n\n### Requirements\n\n- **Node.js v18+**\n- **pnpm** (package manager)\n- **TypeScript** knowledge\n\n### Getting Started\n\n1. **Clone and Install**:\n```bash\ngit clone \u003crepository-url\u003e\ncd llms-txt-generator\npnpm install\n```\n\n2. **Build the Project**:\n```bash\npnpm build\n```\n\n3. **Run Tests**:\n```bash\npnpm test\n```\n\n## Contributing\n\nWe welcome contributions! Please follow these guidelines:\n\n### Development Workflow\n\n1. **Fork** the repository\n2. **Create** a feature branch: `git checkout -b feature/amazing-feature`\n3. **Follow** the project rules in `.trae/project_rules.md`\n4. **Write** tests for new functionality\n5. **Ensure** all tests pass: `pnpm test`\n6. **Lint** your code: `pnpm lint`\n7. **Format** your code: `pnpm format`\n8. **Commit** with conventional commits: `feat: add amazing feature`\n9. **Push** to your branch: `git push origin feature/amazing-feature`\n10. **Create** a Pull Request\n\n### Code Standards\n\n- ✅ **TypeScript**: All code must be written in TypeScript\n- ✅ **Tests**: New features require test coverage\n- ✅ **Documentation**: Update README and JSDoc comments\n- ✅ **Linting**: Code must pass ESLint checks\n- ✅ **Formatting**: Use Prettier for consistent formatting\n- ✅ **Commits**: Follow Conventional Commits specification\n\n## Troubleshooting\n\n### Common Issues\n\n**Q: \"Module not found\" error when using CLI**\n```bash\n# Solution: Install globally or use npx\nnpm install -g llms-txt-generator\n# Or use npx\nnpx llms-txt-generator init\n```\n\n**Q: \"Permission denied\" when running CLI**\n```bash\n# Solution: Make sure the binary is executable\nchmod +x node_modules/.bin/llms-txt-generator\n# Or reinstall the package\npnpm install llms-txt-generator\n```\n\n**Q: \"Configuration file not found\"**\n```bash\n# Solution: Run init command to create configuration\nnpx llms-txt-generator init\n# Or copy from example\ncp llms-txt-generator.example.yaml llms-txt-generator.yaml\n```\n\n**Q: \"TypeScript compilation errors\"**\n```bash\n# Solution: Check Node.js version and dependencies\nnode --version  # Should be \u003e= 18\npnpm install    # Reinstall dependencies\n```\n\n**Q: \"MCP server connection issues\"**\n```bash\n# Solution: Check MCP server configuration\n# Make sure the server path is correct in your MCP client\n# Use full path: /path/to/node_modules/.bin/llms-txt-generator-mcp\n```\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for detailed version history.\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n---\n\n**Made with ❤️ for the AI development community**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faircodelabs%2Fllms-txt-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faircodelabs%2Fllms-txt-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faircodelabs%2Fllms-txt-generator/lists"}