@dbx-tools/cli-args

Generate Commander flags from a Zod object schema so any CLI can share one argument, help, and layered-config path without installing the full dbx package.

Bind And Parse Arguments

import { addArgs, parseArgs } from "@dbx-tools/cli-args";
import { Command } from "commander";
import { z } from "zod";

const OptionsSchema = z.object({
  port: z.coerce.number().default(3000).describe("Server listening port"),
  databaseUrl: z.string().url().describe("PostgreSQL connection string"),
});

const program = addArgs(new Command("demo"), OptionsSchema);
await program.parseAsync(process.argv);
const options = parseArgs(program, OptionsSchema);

Help defaults come from Zod and from layered @dbx-tools/core configuration (environment, .env, bundle, and app YAML). Use .meta({ env, flag, helpDefault }) when a field needs an exact environment name, should stay off the flag list, or should hide its default. A field with helpDefault: false defers layered configuration loading until parseArgs, so rendering --help does not resolve that value.

Serialize Options Back To Argv

import { serializeArgs } from "@dbx-tools/cli-args";

const argv = serializeArgs(OptionsSchema);
const fromValues = serializeArgs({ port: 8080, debug: false });

Schemas serialize their parsed defaults. Concrete objects serialize current values. Boolean false becomes --no-*, arrays become repeated flags, and listener addresses use the shared listen-address format.

Consuming commands define their schemas. This package binds Commander, help, and argv serialization.

See more

Open the complete API reference