{"id":31956333,"url":"https://github.com/profullstack/ai-dot-text","last_synced_at":"2026-07-17T20:32:47.850Z","repository":{"id":318254733,"uuid":"1070505223","full_name":"profullstack/ai-dot-text","owner":"profullstack","description":"ai.txt cli for generating LLMs.txt and ai.txt readable files on web apps.","archived":false,"fork":false,"pushed_at":"2026-05-10T03:33:35.000Z","size":19,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-05-10T05:33:26.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://profullstack.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/profullstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":null,"dco":null,"cla":null}},"created_at":"2025-10-06T03:09:38.000Z","updated_at":"2026-05-10T03:33:40.000Z","dependencies_parsed_at":"2025-10-14T14:50:00.207Z","dependency_job_id":null,"html_url":"https://github.com/profullstack/ai-dot-text","commit_stats":null,"previous_names":["profullstack/ai-dot-text"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/profullstack/ai-dot-text","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profullstack%2Fai-dot-text","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profullstack%2Fai-dot-text/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profullstack%2Fai-dot-text/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profullstack%2Fai-dot-text/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profullstack","download_url":"https://codeload.github.com/profullstack/ai-dot-text/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profullstack%2Fai-dot-text/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35595639,"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-07-17T02:00:06.162Z","response_time":116,"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":[],"created_at":"2025-10-14T14:48:32.478Z","updated_at":"2026-07-17T20:32:47.845Z","avatar_url":"https://github.com/profullstack.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @profullstack/ai-dot-txt\n\nA Node.js CLI tool to generate `ai.txt`, `llms.txt`, `robots.txt`, and `humans.txt` files for your website or application.\n\n## Features\n\n- 🤖 Generate `ai.txt` (robots.txt-like format for AI)\n- 📋 Generate `llms.txt` (JSON format in `.well-known/` directory)\n- 🤖 Generate `robots.txt` (web crawler rules)\n- 👥 Generate `humans.txt` (team credits and site info)\n- 🎯 Interactive CLI with sensible defaults\n- ⚙️ Flexible command-line options\n- 🧪 Fully tested with Mocha + Chai (23 passing tests)\n- ✨ Modern ESM JavaScript (Node.js 20+)\n\n## Installation\n\n### Global Installation\n\n```bash\npnpm add -g @profullstack/ai-dot-txt\n```\n\n### Local Installation\n\n```bash\npnpm add -D @profullstack/ai-dot-txt\n```\n\n### From Source\n\n```bash\ngit clone \u003crepository-url\u003e\ncd ai-dot-txt\npnpm install\n```\n\n## Usage\n\n### Interactive Mode\n\nRun the CLI and answer the prompts:\n\n```bash\naidottxt\n```\n\n### Command-Line Options\n\n```bash\naidottxt [options]\n```\n\n#### Options\n\n- `--out \u003cdir\u003e` - Output directory (default: current directory)\n- `--ai-only` - Generate only `ai.txt`\n- `--llms-only` - Generate only `llms.txt` (in `.well-known/`)\n- `--robots-only` - Generate only `robots.txt`\n- `--humans-only` - Generate only `humans.txt`\n- `--dry-run` - Preview output without writing files\n- `--help, -h` - Show help message\n\n#### Examples\n\nGenerate both files in current directory:\n```bash\naidottxt\n```\n\nGenerate in a specific directory:\n```bash\naidottxt --out ./public\n```\n\nPreview without writing files:\n```bash\naidottxt --dry-run\n```\n\nGenerate only ai.txt:\n```bash\naidottxt --ai-only --out ./dist\n```\n\nGenerate only llms.txt:\n```bash\naidottxt --llms-only\n```\n\nGenerate only robots.txt and humans.txt:\n```bash\naidottxt --robots-only --humans-only\n```\n\n## Output Files\n\n### ai.txt\n\nLocated at the root of your output directory. Format:\n\n```\n# ai.txt for My Site\n# Base: https://example.com\n# Contact: mailto:admin@example.com\n# Models: *\n# Capabilities: chat, embed, fine_tune, crawl, train\n\nUser-agent: *\nAllow: /*\n\nTraining: allow\nRetention: allow\nCommercial-Use: allow\nRate-Limit-RPS: 10\n```\n\n### llms.txt\n\nLocated at `.well-known/llms.txt`. Format:\n\n```json\n{\n  \"version\": \"1.0\",\n  \"site_name\": \"My Site\",\n  \"contact\": \"mailto:admin@example.com\",\n  \"models\": [\"*\"],\n  \"capabilities\": [\"chat\", \"embed\", \"fine_tune\", \"crawl\", \"train\"],\n  \"policy\": {\n    \"allow\": [\"/*\"],\n    \"disallow\": []\n  },\n  \"training\": true,\n  \"retention\": true,\n  \"commercial_use\": true,\n  \"rate_limit_rps\": 10\n}\n```\n\n### robots.txt\n\nLocated at the root of your output directory. Format:\n\n```\nUser-agent: *\nAllow: /api/*\nAllow: /docs/*\nDisallow: /admin/*\nDisallow: /private/*\nCrawl-delay: 1\nSitemap: https://example.com/sitemap.xml\n```\n\n### humans.txt\n\nLocated at the root of your output directory. Format:\n\n```\n/* TEAM */\nDeveloper: John Doe\nContact: https://github.com/johndoe\n\nDesigner: Jane Smith\nContact: https://twitter.com/janesmith\n\n/* THANKS */\nOpen Source Community\nCoffee\n\n/* SITE */\nLast update: 2024/01/01\nLanguage: English\nStandards: HTML5\nComponents: Node.js, JavaScript\n```\n\n## Programmatic Usage\n\nYou can also use this package programmatically:\n\n```javascript\nimport { buildAiTxt, buildLlmsJson } from \"@profullstack/ai-dot-txt\";\n\nconst config = {\n  siteName: \"My Site\",\n  baseUrl: \"https://example.com\",\n  contact: \"mailto:admin@example.com\",\n  models: [\"gpt-4\", \"claude-3\"],\n  capabilities: [\"chat\", \"embed\"],\n  allowPaths: [\"/api/*\", \"/docs/*\"],\n  disallowPaths: [\"/admin/*\"],\n  training: \"allow\",\n  retention: \"allow\",\n  commercialUse: \"disallow\",\n  rateLimitRps: 10,\n};\n\n// Generate ai.txt content\nconst aiTxtContent = buildAiTxt(config);\n\n// Generate llms.txt content\nconst llmsTxtContent = buildLlmsJson(config);\n```\n\n## Configuration Options\n\nWhen running interactively, you'll be prompted for:\n\n- **Site Name**: Your website or application name\n- **Base URL**: Your public base URL\n- **Contact**: Contact information (email, URL, etc.)\n- **Models**: Comma-separated list of allowed AI models (use `*` for all)\n- **Capabilities**: Select from: chat, embed, fine_tune, crawl, train\n- **Allow Paths**: Comma-separated paths to allow (e.g., `/*`, `/api/*`)\n- **Disallow Paths**: Comma-separated paths to disallow (e.g., `/admin/*`)\n- **Training Permission**: Allow or disallow AI training on your content\n- **Retention Permission**: Allow or disallow data retention\n- **Commercial Use**: Allow or disallow commercial use of your content\n- **Rate Limit**: Requests per second limit\n\n## Development\n\n### Install Dependencies\n\n```bash\npnpm install\n```\n\n### Run Tests\n\n```bash\npnpm test\n```\n\n### Run Linter\n\n```bash\npnpm lint\n```\n\n### Fix Linting Issues\n\n```bash\npnpm lint:fix\n```\n\n### Format Code\n\n```bash\npnpm format\n```\n\n## Project Structure\n\n```\n.\n├── src/\n│   ├── args.js        # CLI argument parser\n│   ├── generators.js  # File content generators\n│   ├── cli.js         # Main CLI entry point\n│   └── index.js       # Programmatic API exports\n├── tests/\n│   ├── args.test.js       # Argument parser tests\n│   └── generators.test.js # Generator tests\n├── package.json\n├── eslint.config.js\n├── .prettierrc\n└── README.md\n```\n\n## Requirements\n\n- Node.js \u003e= 20.0.0\n- pnpm (recommended) or npm\n\n## License\n\nMIT\n\n## Contributing\n\nContributions are welcome! Please follow these steps:\n\n1. Fork the repository\n2. Create a feature branch\n3. Write tests for your changes\n4. Ensure all tests pass (`pnpm test`)\n5. Ensure code is linted (`pnpm lint`)\n6. Submit a pull request\n\n## Related Standards\n\nThis project follows several web standards and specifications:\n\n- [humans.txt](https://humanstxt.org/) - See [humans.txt](humans.txt) for team and site information\n- [robots.txt](https://www.robotstxt.org/) - Standard for web robots\n- [llms.txt](https://llmstxt.org/) - LLM-friendly documentation format\n- [ai.txt](https://ai-txt.org/) - AI agent interaction specification\n\n## Author\n\n**Profullstack, Inc.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofullstack%2Fai-dot-text","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofullstack%2Fai-dot-text","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofullstack%2Fai-dot-text/lists"}