mirror of https://github.com/codeflash-ai/codeflash.git synced 2026-05-04 18:25:17 +00:00

History

dependabot[bot] ea57fba470 chore(deps): bump better-sqlite3 in /packages/codeflash Bumps [better-sqlite3](https://github.com/WiseLibs/better-sqlite3) from 12.6.2 to 12.9.0. - [Release notes](https://github.com/WiseLibs/better-sqlite3/releases) - [Commits](https://github.com/WiseLibs/better-sqlite3/compare/v12.6.2...v12.9.0) --- updated-dependencies: - dependency-name: better-sqlite3 dependency-version: 12.9.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>		2026-04-23 10:01:59 +00:00
..
bin	refactor: install Python CLI into isolated venv instead of uv tool	2026-03-26 17:33:56 +02:00
runtime	feat(js): add JavaScript function tracer with Babel instrumentation	2026-04-23 04:33:58 -05:00
scripts	refactor: install Python CLI into isolated venv instead of uv tool	2026-03-26 17:33:56 +02:00
package-lock.json	chore(deps): bump better-sqlite3 in /packages/codeflash	2026-04-23 10:01:59 +00:00
package.json	feat(js): add JavaScript function tracer with Babel instrumentation	2026-04-23 04:33:58 -05:00
README.md	rename package dir	2026-01-27 00:19:07 -08:00

README.md

codeflash

AI-powered code optimization for JavaScript and TypeScript.

Codeflash automatically optimizes your code for better performance while maintaining correctness.

Installation

npm install -D codeflash
# or
yarn add -D codeflash
# or
pnpm add -D codeflash

The installation automatically sets up:

uv - Python package manager (if not already installed)
codeflash - Python CLI for code optimization
Jest runtime helpers - Bundled test instrumentation (capture, serializer, comparator)

Quick Start

# Optimize a specific function
npx codeflash optimize --file src/utils.ts --function fibonacci

# Optimize all functions in a file
npx codeflash optimize --file src/utils.ts

# Get help
npx codeflash --help

Requirements

Node.js >= 18.0.0
Jest (for running tests)
Internet connection (for AI optimization)

How It Works

Analyze: Codeflash analyzes your code and identifies optimization opportunities
Test: Runs your existing tests to capture current behavior
Optimize: Uses AI to generate optimized versions
Verify: Runs tests again to ensure the optimization is correct
Benchmark: Measures performance improvement

Configuration

Create a codeflash.yaml in your project root:

module_root: src
tests_root: tests

CI/CD

In CI environments, the postinstall script is skipped by default. Run setup manually:

npx codeflash-setup

Or set CODEFLASH_SKIP_POSTINSTALL=false to enable automatic setup.

Troubleshooting

uv not found

If you see "uv not found", run the setup script:

npx codeflash-setup

Or install uv manually:

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

codeflash not in PATH

After installation, you may need to restart your terminal or run:

source ~/.bashrc  # or ~/.zshrc

License

MIT