citty · 包 · UnJS 中文

优雅的命令行界面构建器

基于 mri 的快速轻量级参数解析器
智能值解析，支持类型转换、布尔值快捷方式和未知标志处理
嵌套子命令
懒加载和异步命令
可插拔和可组合的 API
自动生成用法说明和帮助信息

🚧 该项目正在大力开发中。更多功能即将推出！

用法

安装包

# npm
npm install citty

# yarn
yarn add citty

# pnpm
pnpm install citty

导入

// ESM
import { defineCommand, runMain } from "citty";

// CommonJS
const { defineCommand, runMain } = require("citty");

定义要运行的主命令

import { defineCommand, runMain } from "citty";

const main = defineCommand({
  meta: {
    name: "hello",
    version: "1.0.0",
    description: "My Awesome CLI App",
  },
  args: {
    name: {
      type: "positional",
      description: "Your name",
      required: true,
    },
    friendly: {
      type: "boolean",
      description: "Use friendly greeting",
    },
  },
  run({ args }) {
    console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
  },
});

runMain(main);