额 额

高级 CLI 构建器

• 基于 玛丽
• 用打字机、布尔快捷键和未知旗帜处理进行智能值分析
• 嵌入子命令
• 懒惰和 Async 命令
• 可插和可堆肥的 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);

用户

defineCommand

defineCommand 是一个用于定义命令的类型助手.

runMain

运行一个有使用支持和优雅错误处理的命令.

createMain

创建环绕命令的包装符 runMain 当召来.

runCommand

解析输入参数并运行命令和子命令(无监督). 您可以访问 result 键从返回/等待的值到访问命令的结果.

parseArgs

解析输入参数并应用默认值.

renderUsage

将命令使用到字符串值 .

showUsage

向主控台提交格式的使用和打印

发展

• 克隆此寄存器
• 安装 LTS 最新版本 节点.js
• 启用 核心软件包 使用 corepack enable
• 使用 pnpm install
• 使用 pnpm dev

许可证

由 . . 出版 MIT 许可证。 。 。 .

参数解析器基于 乳头/乳头 由卢克·爱德华兹(英语:@被指责的 @) (中文(简体) ).