Skip to content

Embed or launch a command application ​

ChoCommand.create(Root, options) returns synchronously after checking module wiring and command declarations. run is asynchronous. Reusing the application for several runs also reuses the services those runs have initialized.

Configure the executable ​

OptionPurpose
nameProgram name in usage and version output. Default chojs
versionVersion reported by --version. When omitted, CHO prints <name> (no version)
parseOptionsParser options shared by every command
onErrorError handler used when a command has no closer @Catch
overridesReplacements for declared providers, typically test doubles

Pass an argument list ​

ts
import { createApp } from "./app.ts"; // from the shelf-label tutorial

const app = createApp();
try {
  const first = await app.run(["label", "The Odyssey"]);
  const second = await app.run(["label", "The Iliad", "--shelf", "classics"]);
  console.log({ first, second }); // both 0
} finally {
  await app.close();
}

Supply one string per shell argument. A quoted title is one array element. Omit the runtime and script name. In a process entry point use Deno.args or process.argv.slice(2). See the complete launch code.

Release resources ​

Close the application after the last run finishes. The injector disposes only instances it created. In particular, printing help does not open a connection whose factory is only needed by an action. Use debug logging to see command selection and initialization.

Released under the MIT License.