Skip to main content

​
CLI Troubleshooting

Solutions for common issues when using the Codeflash CLI.

​
Common Issues

Problem: Function not found because file is outside module-root.Solution: Ensure your file is within the module-root directory specified in pyproject.toml.
# Check your module-root
grep "module-root" pyproject.toml

# Use the correct path (e.g., if module-root is "src")
codeflash --file src/myfile.py --function my_function --no-pr
Problem: Using --benchmark without specifying benchmarks directory.Solution: Either add benchmarks-root to pyproject.toml or use the flag:
codeflash --file src/app.py --benchmark --benchmarks-root tests/benchmarks --no-pr
Problem: Replay test filename doesn’t match expected path.Solution: Replay tests include the module path in their name. Check the actual filename:
# Linux/macOS
ls tests/test_*replay*.py

# Windows
dir tests\test_*replay*.py
Replay test files are named based on the traced script path. For src/app.py, the replay test will be named like test_srcapp_py__replay_test_0.py.
Problem: PR creation fails due to missing GitHub App.Solution: Install the Codeflash GitHub App or use --no-pr for local optimization:
# Local optimization
codeflash --file src/app.py --function main --no-pr

# Or install the GitHub App
# https://github.com/apps/codeflash-ai/installations/select_target
Problem: Codeflash can’t find your Python modules.Solution:
  1. Verify module-root is correctly set in pyproject.toml
  2. Ensure you’re running from the project root
  3. Check that your Python environment has all dependencies installed
# Verify module-root
cat pyproject.toml | grep module-root

# Check Python path
python -c "import sys; print(sys.path)"
Problem: Codeflash can’t generate tests for your function.Solution:
  1. Ensure your function has a return statement
  2. Check that the function is not a property or class method with special decorators
  3. Use --no-gen-tests to skip test generation and use existing tests only
codeflash --file src/app.py --function main --no-gen-tests --no-pr
Problem: Optimization takes too long or times out.Solution:
  1. Use --verbose to see what’s happening
  2. For tracing, use --timeout to limit trace duration
  3. For large functions, consider breaking them down
# Limit trace time
codeflash optimize app.py --timeout 30

# See detailed progress
codeflash --file src/app.py --function main --verbose --no-pr

​
Getting Help

If you’re still experiencing issues:
  1. Check the logs: Use --verbose flag to see detailed output
  2. Verify setup: Run codeflash --verify-setup to check your installation
  3. Check configuration: Ensure pyproject.toml is correctly configured
  4. View help: Run codeflash --help or codeflash <command> --help

​
Next Steps

Setup Commands

Review setup and initialization

Flags Reference

Complete flag reference