Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 1.86 KB

File metadata and controls

60 lines (36 loc) · 1.86 KB

Codegen Examples

Documentation

This is a collection of examples using Codegen. You can use these examples to learn how to use Codegen and build custom code transformations.

Setup

We recommend using uv with Python 3.13 for the best experience.

To install Codegen, please follow the official installation guide. Once Codegen is installed, use these steps to run the examples in this repository:

Install the graph_sitter.cli globally

uv tool install codegen

Initialize Codegen in your project

gs init

Activate the virtual environment

source .codegen/.venv/bin/activate

Your environment is now ready to run example codemods.

IDE Configuration (Optional)

To configure your IDE for optimal use with Codegen, follow our IDE setup guide.

Examples

Within the examples folder, each subdirectory contains a self-contained example with:

  • An explanation of the transformation (README.md)
  • A Codegen script that performs the transformation (run.py)
  • Sample code to transform, if not using a repository (input_repo/)

To see a transformation, simply run the run.py script within the desired directory.

Learn More

Contributing

Have a useful example to share? We'd love to include it! Please see our Contributing Guide for instructions.

License

The Apache 2.0 license.