{"_rev":"3-49c87122fb2186f8f19559743b8d9760","time":{"created":"2026-04-07T17:19:53.473Z","modified":"2026-04-07T17:19:53.967Z","1.0.0":"2026-04-07T16:28:00.969Z","1.0.1":"2026-04-07T17:19:53.765Z"},"_id":"@abhishekkkk15/readmegen-cli","name":"@abhishekkkk15/readmegen-cli","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.1":{"name":"@abhishekkkk15/readmegen-cli","version":"1.0.1","description":"Enterprise README Generator CLI","main":"dist/index.js","bin":{"readmegen":"dist/index.js"},"scripts":{"build":"tsc","start":"node dist/index.js","lint":"eslint ."},"dependencies":{"axios":"^1.14.0","chalk":"^5.3.0","commander":"^12.1.0","conf":"^12.0.0","dotenv":"^16.4.5","glob":"^10.3.12","ignore":"^7.0.5","inquirer":"^9.2.19","ora":"^8.0.1","ts-morph":"^27.0.2","readme-gen-analyzer":"1.0.0"},"devDependencies":{"@types/inquirer":"^9.0.7","@types/node":"^20.12.7","tsx":"^4.19.0","typescript":"^5.4.5"},"type":"module","_id":"@abhishekkkk15/readmegen-cli@1.0.1","gitHead":"99c47a0f4c22d55df4d4e99f52225b929bd0e606","_nodeVersion":"24.10.0","_npmVersion":"9.9.4","dist":{"integrity":"sha512-R0iCozzBWPOrvNaegBmCtqUJ4TBJb2p2Uii4MQzbAJoua0LtTkJZdyMyVjow/zBYIv5e2gLN5knmASywgtzlTQ==","shasum":"24a78ba1d7264d6ecbfa2b1ed671c81257a23367","tarball":"https://registry.npmjs.org/@abhishekkkk15/readmegen-cli/-/readmegen-cli-1.0.1.tgz","fileCount":27,"unpackedSize":119816,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD5rAsidRtyVaOUqoo1E/tOS5CpYzljxPZR33+6NEm+JwIgBNrOfDzzgeGC/rN1fz0bFvwmEKPiSlEWdewgmkjs6dM="}]},"_npmUser":{"name":"abhishekkkk15","email":"abhishekjangid3489@gmail.com"},"directories":{},"maintainers":[{"name":"abhishekkkk15","email":"abhishekjangid3489@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/readmegen-cli_1.0.1_1775582393578_0.5734771764510875"},"_hasShrinkwrap":false}},"maintainers":[{"name":"abhishekkkk15","email":"abhishekjangid3489@gmail.com"}],"description":"Enterprise README Generator CLI","readme":"# 🖥️ @readme-gen/cli\r\n\r\n**The local-first AI documentation engine for your terminal.**\r\n\r\n---\r\n\r\n## 📖 Overview\r\n\r\nThe `readmegen` CLI (also aliased as `devcon`) is a powerful tool for analyzing your local codebase and generating README files without ever leaving your terminal. It leverages the shared `@readme-gen/analyzer` package to extract project grounding evidence and provide state-of-the-art documentation generation.\r\n\r\n---\r\n\r\n## ⚙️ Core Commands\r\n\r\n### 🚦 Quick Start\r\n```bash\r\n# Initialize your API keys and default provider\r\nreadmegen init\r\n\r\n# Generate a basic README with default options\r\nreadmegen generate\r\n\r\n# Preview the last generated README in your terminal\r\nreadmegen preview\r\n```\r\n\r\n### 🛠️ Config Management\r\n```bash\r\n# View your current CLI configuration\r\nreadmegen config view\r\n\r\n# Update a specific provider's API key\r\nreadmegen config set-key <key> --provider groq\r\n\r\n# Set the default model for all generations\r\nreadmegen config set-model <model-id>\r\n\r\n# Reset all CLI settings to default\r\nreadmegen config reset\r\n```\r\n\r\n---\r\n\r\n## 🏗️ Generation Flows\r\n\r\nThe CLI intelligently chooses between two distinct generation paths:\r\n\r\n### 1. Semantic Local Flow (Default)\r\nThe **Semantic Local Flow** uses the analyzer package to build a structured project understanding *locally*. It handles:\r\n- **Rewrite**: Improving an existing README while preserving structure.\r\n- **Append**: Adding new grounded sections derived from code evidence.\r\n- **Dynamic Context**: Injecting extra business context into the generation.\r\n\r\n### 2. Backend / Template Flow\r\nThe **Backend Flow** delegates generation to the API for more complex tasks:\r\n- **Monorepo Templates**: Using pre-defined layouts for complex projects.\r\n- **Nested READMEs**: Generating and saving multiple README files for sub-directories in a single pass.\r\n- **Model Overrides**: Forcing specific platform-hosted models.\r\n\r\n---\r\n\r\n## 💡 Advanced Usage\r\n\r\n### Skipping Interactive Prompts\r\nIf you provide a flag, the CLI is smart enough to skip that specific interactive prompt.\r\n\r\n```bash\r\n# This will skip the \"tone\" Selection and use \"minimal\" automatically\r\nreadmegen generate --tone minimal\r\n```\r\n\r\n### Full Automated Generation\r\nFor CI/CD or non-interactive environments, use the `--yes` flag:\r\n\r\n```bash\r\nreadmegen generate \\\r\n  --tone professional \\\r\n  --persona \"Senior Developer\" \\\r\n  --sections Installation Usage Features \\\r\n  --yes\r\n```\r\n\r\n### Pacing LLM Requests\r\nIf you are working on a large repository and hitting Rate Limits (TPM), use the `--llm-delay-ms` flag:\r\n\r\n```bash\r\nreadmegen generate --llm-delay-ms 30000\r\n```\r\n\r\n---\r\n\r\n## 🛠️ Development\r\n\r\nFrom the workspace root:\r\n\r\n```bash\r\npnpm --filter @readme-gen/cli build\r\npnpm --filter @readme-gen/cli start\r\n```\r\n\r\n---\r\n\r\n<div align=\"center\">\r\n  <sub>Part of the 🚀 <a href=\"../../README.md\">readme-gen</a> ecosystem.</sub>\r\n</div>\r\n","readmeFilename":"README.md"}