Run reviewable multi-step codemod workflows with Codemod CLI
Use Codemod CLI when an agent needs to scaffold, test, and run a reviewable multi-step migration workflow with approval gates, rather than applying a one-off search-and-replace or browsing the hosted Codemod platform.
Prerequisites
Node.js, npm or npx access, target repository, workflow YAML or codemod package
Installation
Use the upstream install or setup path that matches your environment:
- npx codemod
- npx codemod init my-codemod
- npx codemod workflow run -w my-codemod/workflow.yaml
- npx codemod publish my-codemod
Basic usage or getting-started notes:
This repo houses the Codemod CLI and its underlying workflow engine – everything you need to scaffold, test, and run codemods locally or in CI. The CLI can also connect to Codemod’s hosted Registry and Platfor...
Codemod CLI – Run, test, and publish codemods from your terminal or CI.
bash
Extracted from upstream docs: https://raw.githubusercontent.com/codemod/codemod/HEAD/README.md