@refactor-ai/cli

Deterministic TypeScript, JavaScript and C# refactoring CLI.

Use Node.js 22+ and npm. Bun and a source checkout are unnecessary. C# also requires the .NET 8 SDK, the project's required SDK/workloads and restored project dependencies. The bundled Roslyn helper builds on first C# use; initial NuGet restore needs network access and a writable package/cache directory. This package has no install lifecycle scripts.

npx @refactor-ai/cli --help
npx @refactor-ai/cli plan rename --help
npx @refactor-ai/cli plan rename --project examples/typescript/tsconfig.json --file examples/typescript/math.ts --at 1:17 --name sum

Replace example paths with your project paths. Planning leaves sources untouched and returns a saved plan path. Preview and validate it, then apply that exact plan:

npx @refactor-ai/cli preview --plan ./path/to/plan.json
npx @refactor-ai/cli validate --plan ./path/to/plan.json
npx @refactor-ai/cli apply --plan ./path/to/plan.json

Or install with npm install --save-dev @refactor-ai/cli and run npx refactor-ai --help. Plans use snapshots, compiler diagnostics and journaled writes. Validation does not run project tests. Full options, language support, limitations and examples are available in --help.

Built from refactor-ai 0.1.4. Third-party diff license: licenses/diff.txt.

Programmatic use

Importing the package does not execute the CLI, load a project or build the C# helper. createRefactor() returns an object with plan(options), preview(plan), validate(plan), apply(plan), loadPlan(path) and capabilities(project). Methods return objects and reject with Errors rather than printing CLI output. TypeScript declarations are included.

import { createRefactor } from "@refactor-ai/cli";
const refactor = await createRefactor();
const supported = await refactor.capabilities("./tsconfig.json");

Pass operation in plan options. Read API.md for the complete interface, source-change workflow, coordinate conventions, language requirements and automation examples.