Add arguments

Positional arguments are the unnamed values a user types after the command. Declare them with addArguments, in order.

const mycli = new Clipse("mycli", "cli test", "1.0.0")
  .addArguments([{ name: "arg", description: "an argument for test" }])
  .action((args) => {
    console.log(args);
  });

Call it:

$ mycli test

Inside action, args is:

{ "arg": "test" }

Multiple arguments

Arguments are matched to positional values in the order you declare them:

cli.addArguments([
  { name: "source" },
  { name: "destination" },
]);

$ mycli a.txt b.txt
# args = { source: "a.txt", destination: "b.txt" }

Typing

Each declared argument becomes a key on args, typed as string | undefined (a value is undefined when the user provides fewer positionals than declared):

.action((args) => {
  args.source;      // string | undefined
  args.missing;     // ❌ compile error — not a declared argument
})

Guard against missing values with a default:

const dest = args.destination ?? ".";

WARNING

Don't give an argument the same name as a subcommand. If the first word matches a subcommand, clipse dispatches to that subcommand instead of treating it as an argument.