@code-engine/cli

CodeEngine CLI

This is the command-line interface for CodeEngine. It exports the CodeEngineCLI class, which runs CodeEngine as instructed by the command-line arguments and environment variables.

NOTE: This is an internal library that is only intended to be used by CodeEngine. Using it outside of CodeEngine is discouraged. Use the code-engine npm package instead.

CodeEngineCLI class

This is the programmatic interface to the CodeEngine CLI.

import CodeEngineCLI from "@code-engine/cli";
import manifest from "./package.json";

// Create a new CodeEngineCLI instance
let cli = new CodeEngineCLI({ manifest });

// Run it with some command-line arguments
await cli.main(["--debug", "my-generator"]);

CodeEngineCLI constructor

The constructor accepts a Config object.

import CodeEngineCLI from "@code-engine/cli";

// Create a new CodeEngineCLI instance with a custom config
let cli = new CodeEngine({
  manifest: {
    name: "my-custom-cli",
    version: "1.23.456",
    description: "My custom CLI description",
  },
  process: {
    ...process,
    stdout: new WriteStream(),
    stderr: new WriteStream(),
  }
});

Config setting	Required	Type	Default	Description
manifest	yes	object	none	Information about your CLI, such as its name, version number, and description. You can just set this to the contents of your package.json file.
process	no	Process object	process (Node.js global)	A custom Process object to use instead of the Node.js global process object. This allows you to completely control all inputs and outputs.

CodeEngineCLI.log(message)

Writes a message to the stdout stream.

• message: The string to write to stdout

import CodeEngineCLI from "@code-engine/cli";
import manifest from "./package.json";

let cli = new CodeEngineCLI({ manifest });

cli.log("Hello, world");

CodeEngineCLI.error(message)

Writes a message to the stderr stream.

• message: The string to write to stderr

import CodeEngineCLI from "@code-engine/cli";
import manifest from "./package.json";

let cli = new CodeEngineCLI({ manifest });

cli.error("Something went wrong");

CodeEngineCLI.crash(error)

Immediately terminates the CLI with the given error.

• error: An Error object

NOTE: This method calls process.exit() internally. By default this will terminate the entire Node.js process. You can override this behavior by providing your own process object in the constructor and implementing the exit() method however you choose.

import CodeEngineCLI from "@code-engine/cli";
import manifest from "./package.json";

let cli = new CodeEngineCLI({ manifest });

cli.crash(new SyntaxError("Something went wrong"));

CodeEngineCLI.awaitExit()

Waits for the CLI to exit. This function returns a Promise that only resolves when the "exit" event is emitted.

NOTE: This method calls process.on("exit") internally. By default this will wait for the Node.js process to exit. You can override this behavior by providing your own process object in the constructor and implementing the on() method however you choose.

import CodeEngineCLI from "@code-engine/cli";
import manifest from "./package.json";

let cli = new CodeEngineCLI({ manifest });

await cli.awaitExit();

Contributing

Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.

Building

To build the project locally on your computer:

1. Clone this repo
   git clone https://github.com/CodeEngineOrg/code-engine-cli.git

2. Install dependencies
   npm install

3. Build the code
   npm run build

4. Run the tests
   npm test

License

@code-engine/cli is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤