flick

nodejs cli utils like fire(python)

features

• safety typing
• easy to define

usage

install

pnpm add @quik-fe/flick

import { flick } from "@quik-fe/flick";
import { z } from "zod";

const argsDef = {
  greet: z
    .object({
      name: z.string().describe("Name to greet"),
      times: z.number().optional().default(1).describe("Number of repetitions"),
      upcase: z.boolean().optional().describe("Uppercase the name"),
    })
    .describe("Greet a person multiple times"),
};

flick(argsDef)
  .describe("Hello world from flick")
  .handler({
    greet: ({ name, times, upcase }) => {
      let text = `👋 Hello, ${name}`;
      if (upcase) text = text.toUpperCase();
      for (let i = 0; i < times; i++) {
        console.log(text);
      }
    },
  })
  .parse();

$ npx tsx ./demo.ts -h
Usage: demo [options] [command]

Hello world from flick

Options:
  -h, --help       display help for command

Commands:
  greet [options]  Greet a person multiple times
  help [command]   display help for command

$ npx tsx ./demo.ts greet -h
Usage: demo greet [options]

Greet a person multiple times

Options:
  --name <name>    Name to greet
  --times <times>  Number of repetitions (default: 1)
  --upcase         Uppercase the name
  -h, --help       display help for command

$ npx tsx ./demo.ts greet --name lenml --no-upcase --times=3
👋 Hello, lenml
👋 Hello, lenml
👋 Hello, lenml

If you define a boolean-type parameter, you can also use a hidden --no-<key> parameter to indicate negation.

LICENSE

MIT