Skip to content

cli

@evolve-framework/cli · v1.0.0

The evolve command-line tool. It collects the commands your project and its installed packages declare and runs them behind one entry point, such as evolve simulate from the commercetools package or evolve create built into the CLI.

When to use

Install it in a project that wants the commands its Evolve packages provide, or that puts its own server and jobs behind evolve <command>. A package that ships commands depends on it for the Subcommand base class. A service that never runs a maintenance command from the terminal does not need it.

Get started

  1. Install the package. It comes from the Evolve registry, which needs a one-time sign-in.

    pnpm add @evolve-framework/cli
    Requirements1
    @types/node>=22optional

For example:

evolve --help # everything available in this project
evolve simulate order confirm --order ORD-1

Entry points

@evolve-framework/cliThe evolve binary, the Subcommand base class and defineCommands for packages that ship commands, and the loader for running the CLI programmatically.16 exports