codeflash-admin/codeflash
1
0
Fork 0
mirror of https://github.com/codeflash-ai/codeflash.git synced 2026-05-04 18:25:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
codeflash/npm-package
History
Sarthak Agarwal 29e0e190c5 add refinement and cleanup
2026-01-21 05:28:03 +05:30
..
bin add refinement and cleanup 2026-01-21 05:28:03 +05:30
package.json add refinement and cleanup 2026-01-21 05:28:03 +05:30
README.md add refinement and cleanup 2026-01-21 05:28:03 +05:30

README.md

codeflash

AI-powered code performance optimization for JavaScript and TypeScript.

Installation

npm install -g codeflash
# or
npx codeflash

Quick Start

  1. Get your API key from codeflash.ai

  2. Set your API key:

export CODEFLASH_API_KEY=your-api-key
  1. Optimize a function:
codeflash --file src/utils.ts --function slowFunction

Usage

# Optimize a specific function
codeflash --file <path> --function <name>

# Optimize all functions in a directory
codeflash --all src/

# Initialize GitHub Actions workflow
codeflash init-actions

# Verify setup
codeflash --verify-setup

Requirements

  • Node.js >= 16.0.0
  • A codeflash API key

Supported Platforms

  • Linux (x64, arm64)
  • macOS (x64, arm64)
  • Windows (x64)

Documentation

See codeflash.ai/docs for full documentation.

License

BSL-1.1