code-health-copilot
v1.0.0
Published
Automated code health and security analysis for modern web projects. Find and fix issues before they become a problem.
Maintainers
Readme
Code Health Copilot
Automated code health and security analysis for modern web projects. Find and fix issues before they become a problem.
Code Health Copilot is a command-line tool that scans your projects for common but critical issues like hardcoded secrets and vulnerable dependencies. It offers a free scan to identify problems and a premium, one-command fix to resolve them automatically.
Features
- High-Impact Scans: Detects critical vulnerabilities that are often overlooked.
- Freemium Model: Use the
scancommand for free, forever. See the value before you pay. - Automated Fixes: Upgrade to the premium
fixcommand to automatically patch issues in seconds. - CI/CD Integration: Designed to be integrated into your GitHub Actions to act as a security gate.
Installation
npm install -g code-health-copilotHow to Use
1. Scan Your Project (Free)
Run the scan command in your project's root directory. It will analyze your code and generate a code_health_report.md file detailing any issues it finds.
code-health-copilot scanIf issues are found, the report will list them. The command will also provide a gentle suggestion to use the premium fix feature.
2. Automatically Fix Issues (Premium)
To enable the automated fix feature, you first need to purchase a license key from our website (e.g., https://example.com/get-api-key).
Once you have your key, run the fix command with the key set as an environment variable.
CODE_HEALTH_API_KEY="YOUR-API-KEY-HERE" code-health-copilot fixThe tool will validate your key and then proceed to automatically:
- Patch files with hardcoded secrets.
- Update vulnerable dependencies to their latest secure versions.
- And much more!
Built with ❤️ for the developer community.
