Codeflash - AI-powered code optimization for JavaScript and TypeScript
npm install codeflashAI-powered code optimization for JavaScript and TypeScript.
Codeflash automatically optimizes your code for better performance while maintaining correctness.
``bash`
npm install -D codeflashor
yarn add -D codeflashor
pnpm add -D codeflash
The installation automatically sets up:
1. uv - Python package manager (if not already installed)
2. codeflash - Python CLI for code optimization
3. Jest runtime helpers - Bundled test instrumentation (capture, serializer, comparator)
`bashOptimize a specific function
npx codeflash optimize --file src/utils.ts --function fibonacci
Requirements
- Node.js >= 18.0.0
- Jest (for running tests)
- Internet connection (for AI optimization)
How It Works
1. Analyze: Codeflash analyzes your code and identifies optimization opportunities
2. Test: Runs your existing tests to capture current behavior
3. Optimize: Uses AI to generate optimized versions
4. Verify: Runs tests again to ensure the optimization is correct
5. Benchmark: Measures performance improvement
Configuration
Create a
in your project root:`yaml
module_root: src
tests_root: tests
`CI/CD
In CI environments, the postinstall script is skipped by default. Run setup manually:
bash
npx codeflash-setup
`Or set
to enable automatic setup.Troubleshooting
$3
If you see "uv not found", run the setup script:
`bash
npx codeflash-setup
`Or install uv manually:
bash
macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | shWindows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
`$3
After installation, you may need to restart your terminal or run:
bash
source ~/.bashrc # or ~/.zshrc
``- Documentation
- GitHub
- Discord
MIT