A lightweight, type-safe CLI framework built with Zod for creating command-line applications with minimal boilerplate.
- Type-safe command and argument definitions with Zod schemas
- Automatic help text generation
- Colored terminal output formatting
- Simple API for defining commands and handlers
npm install @rubriclab/cliimport { createCLI } from '@rubriclab/cli';
import { z } from 'zod';
const cli = createCLI({
name: 'mycli',
version: '1.0.0',
description: 'My CLI tool',
commands: [
createCommand({
name: 'greet',
description: 'Greet someone',
args: z.object({
name: z.string().describe('Name to greet'),
uppercase: z.boolean().default(false).describe('Uppercase the greeting')
}),
handler: ({ name, uppercase }) => {
const greeting = `Hello, ${name}!`;
console.log(uppercase ? greeting.toUpperCase() : greeting);
}
})
]
});
cli.parse();# Show help
mycli --help
# Run a command
mycli greet --name "World"
# With a boolean flag
mycli greet --name "World" --uppercaseCreates a new CLI instance with the specified configuration.
type CLIConfig = {
name: string; // Name of your CLI tool
version: string; // Version number
description: string; // Brief description
commands: Command[]; // Array of command definitions
};type Command<TArgs extends z.ZodType = z.ZodObject<any>> = {
name: string; // Command name used in CLI
description: string; // Command description shown in help
args: TArgs; // Zod schema for command arguments
handler: (args: z.infer<TArgs>) => void | Promise<void>; // Command implementation
};The library provides utilities for formatting terminal output:
import { format } from '@rubriclab/cli';
console.log(format.success('Operation completed!'));
console.log(format.error('Something went wrong'));
console.log(format.warning('Proceed with caution'));
console.log(format.info('Did you know?'));
console.log(format.command('command-name'));
console.log(format.parameter('--flag'));
console.log(format.title('SECTION TITLE'));Arguments are automatically parsed from command line flags:
--flag valuefor string/number values--flagfor boolean flags (true if present)- Validation and default values from Zod schemas
MIT