@burdenoff / cli-sdk

模块化CLI SDK在所有Burdenoff产品CLI之间共享。每个模块导出一个 CliModule 合同;产品cli (vibecontrols-cli， botlit-cli， fluidgrids-cli等)变成薄壳，选择安装哪些模块。

安装

bun add @burdenoff/cli-sdk commander graphql graphql-request

commander， graphql， graphql-request 是对等的深度——你的shell会直接安装它们。

使用

#!/usr/bin/env node
import { createProgram, buildContext } from '@burdenoff/cli-sdk/core';
import authModule from '@burdenoff/cli-sdk/modules/auth';
import vibecontrolsModule from '@burdenoff/cli-sdk/modules/vibecontrols';

const ctx = buildContext({
  productName: 'vibecontrols',
  productVersion: '1.0.0',
  defaults: {
    configDirName: 'vibecontrols-cli',
    oidcClientId: 'burdenoff_cli_vibecontrols',
    workspaceEndpointDefault: 'http://localhost:4003/workspaces/graphql',
    globalEndpointDefault: 'http://localhost:4000/global/graphql',
  },
});

const program = createProgram(ctx, [authModule, vibecontrolsModule], {
  name: 'vibecontrols',
  version: '1.0.0',
});

program.parseAsync(process.argv);

模块的合同

export interface CliModule {
  id: string;
  version: string;
  displayName: string;
  dependsOn?: readonly string[];
  register(program: Command, ctx: CLIContext): void;
  api?: (ctx: CLIContext) => unknown;
}

看到 src/core/module.ts 对于完整的类型。

开发

bun install
bun run sanity   # format + lint + typecheck + build + test