@vellumai/plugin-api 0.10.7-dev.202607101106.c87f4e3 → 0.10.7-dev.202607101252.74ea83d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +37 -0
  2. package/index.js +1 -0
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1909,6 +1909,25 @@ declare interface ClawhubSlimSkill extends SlimSkillBase {
1909
1909
  version: string;
1910
1910
  }
1911
1911
 
1912
+ export declare const CLI_COMMAND_HELP: readonly CliCommandHelp[];
1913
+
1914
+ /**
1915
+ * Fully declarative description of a top-level `assistant` CLI command and its
1916
+ * subcommands. Plain data by design — no action handlers — so plugins (e.g. the
1917
+ * memory capability indexer) can import a command's help and iterate over it
1918
+ * without dragging in the CLI's daemon/IPC action graph. Command modules apply
1919
+ * the same data via {@link applyCommandHelp}, then attach their handlers.
1920
+ */
1921
+ declare interface CliCommandHelp {
1922
+ name: string;
1923
+ description: string;
1924
+ /** Options declared directly on the top-level command. */
1925
+ options?: CliOptionHelp[];
1926
+ /** Extra help appended after the option list (`addHelpText("after", …)`). */
1927
+ helpText?: string;
1928
+ subcommands?: CliSubcommandHelp[];
1929
+ }
1930
+
1912
1931
  declare interface ClientEntry extends BaseSubscriberEntry {
1913
1932
  type: "client";
1914
1933
  clientId: string;
@@ -1936,6 +1955,24 @@ declare interface ClientSettingsUpdate {
1936
1955
  value: string;
1937
1956
  }
1938
1957
 
1958
+ declare interface CliOptionHelp {
1959
+ /** Commander flag spec, e.g. `"--path <file>"` or `"-l, --limit <n>"`. */
1960
+ flags: string;
1961
+ description: string;
1962
+ /** When true, applied via `requiredOption` (missing → error) rather than `option`. */
1963
+ required?: boolean;
1964
+ /** Default value passed to `option(flags, description, defaultValue)`. */
1965
+ defaultValue?: string;
1966
+ }
1967
+
1968
+ declare interface CliSubcommandHelp {
1969
+ name: string;
1970
+ description: string;
1971
+ options?: CliOptionHelp[];
1972
+ /** Extra help appended after the option list (`addHelpText("after", …)`). */
1973
+ helpText?: string;
1974
+ }
1975
+
1939
1976
  declare type CompactionCircuitClosedEvent = z.infer<typeof CompactionCircuitClosedEventSchema>;
1940
1977
 
1941
1978
  declare const CompactionCircuitClosedEventSchema: z.ZodObject<{
package/index.js CHANGED
@@ -1,5 +1,6 @@
1
1
  // Generated by scripts/build-plugin-api.ts — do not edit by hand.
2
2
  const api = globalThis[Symbol.for("vellum.plugin-api")] ?? {};
3
+ export const CLI_COMMAND_HELP = api.CLI_COMMAND_HELP;
3
4
  export const HOOKS = api.HOOKS;
4
5
  export const RiskLevel = api.RiskLevel;
5
6
  export const addMessage = api.addMessage;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vellumai/plugin-api",
3
- "version": "0.10.7-dev.202607101106.c87f4e3",
3
+ "version": "0.10.7-dev.202607101252.74ea83d",
4
4
  "description": "Public TypeScript authoring contract for Vellum assistant plugins.",
5
5
  "license": "MIT",
6
6
  "type": "module",