@pellux/goodvibes-tui 0.19.24 → 0.19.26

package/src/cli/entrypoint.ts

@@ -0,0 +1,169 @@
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { ConfigManager } from '../config/index.ts';
+import { readOnboardingCompletionMarkers } from '../runtime/onboarding/index.ts';
+import { GlobalNetworkTransportInstaller } from '@pellux/goodvibes-sdk/platform/runtime/network/index';
+import { createShellPathService } from '@pellux/goodvibes-sdk/platform/runtime/shell-paths';
+import { configureActivityLogger } from '@pellux/goodvibes-sdk/platform/utils/logger';
+import {
+  applyRuntimeCommandEndpointFlagOverrides,
+  applyRuntimeConfigOverrides,
+  applyRuntimeConfigValue,
+  applyRuntimeFeatureFlagOverrides,
+  buildCliStatusSnapshot,
+  handleGoodVibesCliCommand,
+  parseGoodVibesCli,
+  renderCliStatus,
+  renderCompletion,
+  renderGoodVibesCommandHelp,
+  renderGoodVibesHelp,
+  renderGoodVibesVersion,
+  renderOnboardingCliStatus,
+} from './index.ts';
+import { buildCliServicePosture } from './service-posture.ts';
+
+type ShellEntrypointOwnership = {
+  readonly workingDirectory: string;
+  readonly homeDirectory: string;
+};
+
+export type ShellEntrypointRoots = {
+  readonly defaultWorkingDirectory: string;
+  readonly homeDirectory: string;
+};
+
+export type PreparedShellCliRuntime = {
+  readonly cli: ReturnType<typeof parseGoodVibesCli>;
+  readonly configManager: ConfigManager;
+  readonly bootstrapWorkingDir: string;
+  readonly bootstrapHomeDirectory: string;
+};
+
+function resolveShellEntrypointOwnership(roots: ShellEntrypointRoots, workingDirOverride?: string): ShellEntrypointOwnership {
+  return {
+    workingDirectory: workingDirOverride ?? roots.defaultWorkingDirectory,
+    homeDirectory: roots.homeDirectory,
+  };
+}
+
+export async function prepareShellCliRuntime(
+  argv: readonly string[],
+  roots: ShellEntrypointRoots,
+  binary = 'goodvibes',
+): Promise<PreparedShellCliRuntime> {
+  const cli = parseGoodVibesCli(argv, binary);
+
+  if (cli.errors.length > 0) {
+    console.error(cli.errors.join('\n'));
+    console.error('');
+    console.error(renderGoodVibesHelp(binary));
+    process.exit(2);
+  }
+
+  if (cli.flags.help || cli.command === 'help') {
+    const helpTopic = cli.command === 'help'
+      ? cli.commandArgs[0]
+      : cli.rawCommand ?? undefined;
+    console.log(helpTopic ? renderGoodVibesCommandHelp(helpTopic, binary) : renderGoodVibesHelp(binary));
+    process.exit(0);
+  }
+
+  if (cli.flags.version || cli.command === 'version') {
+    console.log(renderGoodVibesVersion(binary));
+    process.exit(0);
+  }
+
+  if (cli.command === 'completion') {
+    console.log(renderCompletion(cli.commandArgs[0], binary));
+    process.exit(0);
+  }
+
+  if (cli.command === 'serve') {
+    await import('../daemon/cli.ts');
+    return new Promise<PreparedShellCliRuntime>(() => {});
+  }
+
+  const {
+    workingDirectory: bootstrapWorkingDir,
+    homeDirectory: bootstrapHomeDirectory,
+  } = resolveShellEntrypointOwnership(roots, cli.flags.workingDir ?? (cli.command === 'tui' ? cli.commandArgs[0] : undefined));
+  configureActivityLogger(join(bootstrapWorkingDir, '.goodvibes', 'logs'));
+  const configManager = new ConfigManager({
+    workingDir: bootstrapWorkingDir,
+    homeDir: bootstrapHomeDirectory,
+    surfaceRoot: 'tui',
+  });
+  new GlobalNetworkTransportInstaller().install(configManager);
+
+  const overrideErrors = applyRuntimeConfigOverrides(configManager, cli.flags.configOverrides);
+  if (overrideErrors.length > 0) {
+    console.error(overrideErrors.join('\n'));
+    process.exit(2);
+  }
+  applyRuntimeFeatureFlagOverrides(configManager, {
+    enableFeatures: cli.flags.enableFeatures,
+    disableFeatures: cli.flags.disableFeatures,
+  });
+
+  if (cli.flags.provider !== undefined) {
+    applyRuntimeConfigValue(configManager, 'provider.provider', cli.flags.provider);
+  }
+  if (cli.flags.model !== undefined) {
+    applyRuntimeConfigValue(configManager, 'provider.model', cli.flags.model);
+  }
+  const endpointOverrideErrors = applyRuntimeCommandEndpointFlagOverrides(configManager, cli.command, cli.flags);
+  if (endpointOverrideErrors.length > 0) {
+    console.error(endpointOverrideErrors.join('\n'));
+    process.exit(2);
+  }
+
+  if (cli.command === 'status' || cli.command === 'doctor' || (cli.command === 'onboarding' && cli.commandArgs[0] === 'status')) {
+    const shellPaths = createShellPathService({
+      workingDirectory: bootstrapWorkingDir,
+      homeDirectory: bootstrapHomeDirectory,
+    });
+    const userStorePath = shellPaths.resolveUserPath('tui', 'auth-users.json');
+    const bootstrapCredentialPath = shellPaths.resolveUserPath('tui', 'auth-bootstrap.txt');
+    const operatorTokenPath = join(bootstrapHomeDirectory, '.goodvibes', 'daemon', 'operator-tokens.json');
+    const onboardingMarkers = readOnboardingCompletionMarkers(shellPaths);
+    const service = await buildCliServicePosture({
+      configManager,
+      workingDirectory: bootstrapWorkingDir,
+      homeDirectory: bootstrapHomeDirectory,
+    });
+    const statusOptions = {
+      configManager,
+      workingDirectory: bootstrapWorkingDir,
+      homeDirectory: bootstrapHomeDirectory,
+      onboardingMarkers,
+      auth: {
+        userStorePath,
+        userStorePresent: existsSync(userStorePath),
+        bootstrapCredentialPath,
+        bootstrapCredentialPresent: existsSync(bootstrapCredentialPath),
+        operatorTokenPath,
+        operatorTokenPresent: existsSync(operatorTokenPath),
+      },
+      service,
+      doctor: cli.command === 'doctor',
+      outputFormat: cli.flags.outputFormat,
+    };
+    const snapshot = buildCliStatusSnapshot(statusOptions);
+    console.log(cli.command === 'onboarding'
+      ? renderOnboardingCliStatus(statusOptions)
+      : renderCliStatus(statusOptions));
+    process.exit(cli.command === 'doctor' && snapshot.findings.length > 0 ? 1 : 0);
+  }
+
+  const cliCommandResult = await handleGoodVibesCliCommand({
+    cli,
+    configManager,
+    workingDirectory: bootstrapWorkingDir,
+    homeDirectory: bootstrapHomeDirectory,
+  });
+  if (cliCommandResult.handled) {
+    process.exit(cliCommandResult.exitCode);
+  }
+
+  return { cli, configManager, bootstrapWorkingDir, bootstrapHomeDirectory };
+}

package/src/cli/help.ts

@@ -0,0 +1,301 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const FALLBACK_VERSION = '0.19.24';
+
+function readJsonVersion(path: string): string | null {
+  try {
+    if (!existsSync(path)) return null;
+    const parsed = JSON.parse(readFileSync(path, 'utf-8')) as { version?: unknown };
+    return typeof parsed.version === 'string' ? parsed.version : null;
+  } catch {
+    return null;
+  }
+}
+
+export function getPackageVersion(): string {
+  const here = dirname(fileURLToPath(import.meta.url));
+  return readJsonVersion(join(here, '..', '..', 'package.json'))
+    ?? process.env.npm_package_version
+    ?? FALLBACK_VERSION;
+}
+
+export function renderGoodVibesVersion(binary = 'goodvibes'): string {
+  return `${binary} ${getPackageVersion()}`;
+}
+
+export function renderGoodVibesHelp(binary = 'goodvibes'): string {
+  return [
+    `Usage: ${binary} [OPTIONS] [PROMPT]`,
+    `       ${binary} [OPTIONS] <COMMAND> [ARGS]`,
+    '',
+    'Commands:',
+    '  tui [path]                 Start the interactive TUI (default)',
+    '  run|exec [prompt]          Run non-interactively with text/json/stream-json output',
+    '  serve|daemon               Start the daemon/API host',
+    '  web                        Show browser surface bind URL and enablement',
+    '  service                    Inspect/manage daemon service lifecycle',
+    '  status                     Print config, provider, service, and onboarding posture',
+    '  doctor                     Print status plus setup warnings',
+    '  onboarding [status]        Open onboarding in the TUI, or print onboarding status',
+    '  models [provider]          List/use/pin selectable models and recent model history',
+    '  providers                  List/inspect/use provider config/auth posture',
+    '  auth                       Inspect and manage local users, sessions, and bootstrap auth',
+    '  subscription               Start/finish/logout provider subscription sessions',
+    '  secrets                    List, set, link, delete, and test GoodVibes secret refs',
+    '  sessions                   List, show, export, or resume saved sessions',
+    '  tasks                      List/show in-process tasks or submit a non-interactive task',
+    '  pair|qrcode                Print companion pairing payload and QR code',
+    '  surfaces                   Inspect/check/enable/disable browser/listener/external surfaces',
+    '  listener test              Test HTTP listener/webhook readiness',
+    '  control-plane status       Inspect daemon auth, local admin, tokens, and ports',
+    '  bundle export|inspect|import',
+    '                             Move setup/profile/trust/support bundles',
+    '  remote|bridge              Inspect remote runner/node posture',
+    '  completion <shell>         Generate shell completion script',
+    '  help [command]             Print this help or command-specific help',
+    '  version                    Print version',
+    '',
+    'Options:',
+    '  -m, --model <registryKey>       Override model. provider:model infers --provider',
+    '      --provider <id>            Override provider',
+    '  -C, --cd <dir>                 Set working directory for this launch',
+    '      --working-dir <dir>        Alias for --cd',
+    '      --daemon-home <dir>        Override daemon home for daemon-backed commands',
+    '  -c, --config <key=value>       Override a config value for this launch',
+    '      --enable <feature>         Enable a feature flag for this launch',
+    '      --disable <feature>        Disable a feature flag for this launch',
+    '  -p, --prompt <text>            Run a non-interactive prompt',
+    '      --print                    Alias for non-interactive run mode',
+    '  -o, --output <format>          text, json, or stream-json',
+    '      --output-format <format>   Alias for --output',
+    '      --json                     Alias for --output-format json',
+    '      --no-alt-screen            Keep output in normal terminal scrollback',
+    '      --port <port>              Port for server/web commands',
+    '      --hostname <host>          Hostname for server/web commands',
+    '      --open                     Open browser when supported',
+    '  -r, --resume [id|latest]       Resume saved session when supported',
+    '  -s, --session <id>             Use a specific session when supported',
+    '      --continue                 Continue the latest session when supported',
+    '      --fork                     Fork session when supported',
+    '  -h, --help                     Print help',
+    '  -v, --version                  Print version',
+    '',
+    'Examples:',
+    `  ${binary}`,
+    `  ${binary} --no-alt-screen`,
+    `  ${binary} --cd ~/work/project --model openai:gpt-5.2`,
+    `  ${binary} onboarding`,
+    `  ${binary} onboarding status`,
+    `  ${binary} status`,
+    `  ${binary} models current`,
+    `  ${binary} models use openai:gpt-5.2`,
+    `  ${binary} providers inspect openai`,
+    `  ${binary} surfaces`,
+    `  ${binary} surfaces check`,
+    `  ${binary} surfaces enable web`,
+    `  ${binary} service check`,
+    `  ${binary} listener test`,
+    `  ${binary} control-plane status`,
+    `  ${binary} subscription providers`,
+    `  ${binary} subscription login openai start --open`,
+    `  ${binary} serve --hostname 0.0.0.0 --port 3421`,
+  ].join('\n');
+}
+
+type CommandHelp = {
+  readonly usage: readonly string[];
+  readonly summary: string;
+  readonly subcommands?: readonly string[];
+  readonly examples?: readonly string[];
+};
+
+const COMMAND_HELP: Record<string, CommandHelp> = {
+  tui: {
+    usage: ['tui [path]', '[prompt]'],
+    summary: 'Start the interactive terminal UI. A prompt starts the TUI with that prompt seeded.',
+    examples: ['', 'tui ~/work/project', '"review this repo"'],
+  },
+  run: {
+    usage: ['run [prompt] [--output text|json|stream-json]', 'exec [prompt]'],
+    summary: 'Run a single non-interactive agent turn and write the result to stdout.',
+    examples: ['run "summarize the current project"', 'run --output json "list risks"', 'exec --output stream-json "fix lint"'],
+  },
+  onboarding: {
+    usage: ['onboarding', 'setup', 'onboarding status'],
+    summary: 'Open the setup wizard on the next TUI startup, or inspect onboarding marker status from the CLI.',
+    examples: ['onboarding', 'onboarding status'],
+  },
+  status: {
+    usage: ['status', 'status --json'],
+    summary: 'Print config, provider, auth, service, surface, and onboarding posture.',
+    examples: ['status', 'status --json'],
+  },
+  doctor: {
+    usage: ['doctor', 'doctor --json'],
+    summary: 'Print status plus actionable setup warnings with cause, impact, and next action.',
+    examples: ['doctor', 'doctor --json'],
+  },
+  providers: {
+    usage: ['providers [list]', 'providers current', 'providers inspect <provider>', 'providers use <provider> [modelRegistryKey]'],
+    summary: 'Inspect and change provider setup, auth posture, model counts, and setup class.',
+    examples: ['providers', 'providers inspect openai-subscriber', 'providers use openai openai:gpt-5.4'],
+  },
+  models: {
+    usage: ['models [provider]', 'models current', 'models use <registryKey>', 'models pin <registryKey>', 'models recent'],
+    summary: 'List, inspect, select, pin, and review model choices.',
+    examples: ['models current', 'models openai', 'models use openai:gpt-5.4'],
+  },
+  auth: {
+    usage: ['auth status', 'auth users', 'auth sessions', 'auth add-user <username>', 'auth clear-bootstrap'],
+    summary: 'Inspect and manage local admin users, bootstrap auth, and local sessions.',
+    examples: ['auth', 'auth add-user admin --password-stdin', 'auth clear-bootstrap'],
+  },
+  subscription: {
+    usage: ['subscription list', 'subscription providers', 'subscription inspect <provider>', 'subscription login <provider> start|finish', 'subscription logout <provider>'],
+    summary: 'Manage OAuth/subscription-backed provider sessions such as OpenAI subscription access.',
+    examples: ['subscription providers', 'subscription login openai start --open', 'subscription inspect openai'],
+  },
+  secrets: {
+    usage: ['secrets list', 'secrets providers', 'secrets test goodvibes://secrets/<source>/...', 'secrets set <KEY> <value>', 'secrets link <KEY> <ref>'],
+    summary: 'Manage GoodVibes secret records and secret references. Secret refs never embed secret values.',
+    examples: ['secrets providers', 'secrets test goodvibes://secrets/env/OPENAI_API_KEY', 'secrets link OPENAI_API_KEY goodvibes://secrets/env/OPENAI_API_KEY'],
+  },
+  sessions: {
+    usage: ['sessions list', 'sessions show <id|name>', 'sessions export <id|name> [path]', 'sessions resume <id|name>'],
+    summary: 'List, inspect, export, or resume saved TUI sessions.',
+    examples: ['sessions list', 'sessions show latest-session', 'sessions export abc123 session.json'],
+  },
+  tasks: {
+    usage: ['tasks list', 'tasks show <taskId>', 'tasks submit <prompt>'],
+    summary: 'Inspect runtime tasks or submit a non-interactive task.',
+    examples: ['tasks list', 'tasks submit "check provider readiness"'],
+  },
+  surfaces: {
+    usage: ['surfaces [list]', 'surfaces check', 'surfaces show <surfaceId>', 'surfaces enable <web|listener|control-plane|surfaceId>', 'surfaces disable <surfaceId>'],
+    summary: 'Inspect and configure browser, control-plane, HTTP listener, and external integration surfaces.',
+    examples: ['surfaces check', 'surfaces enable web', 'surfaces enable slack'],
+  },
+  listener: {
+    usage: ['listener test'],
+    summary: 'Check HTTP listener/webhook readiness, network posture, service posture, auth, and enabled surface requirements.',
+    examples: ['listener test', 'listener test --json'],
+  },
+  'control-plane': {
+    usage: ['control-plane status'],
+    summary: 'Inspect daemon control-plane bind posture, reachability, local auth, bootstrap credentials, and operator tokens.',
+    examples: ['control-plane status', 'control-plane status --json'],
+  },
+  bundle: {
+    usage: ['bundle export [path]', 'bundle inspect <path>', 'bundle import <path>'],
+    summary: 'Export, inspect, or import setup/profile/trust/support bundle data.',
+    examples: ['bundle export goodvibes-bundle.json', 'bundle inspect goodvibes-bundle.json'],
+  },
+  pair: {
+    usage: ['pair', 'qrcode'],
+    summary: 'Print companion pairing connection details and a QR code.',
+    examples: ['pair', 'qrcode'],
+  },
+  web: {
+    usage: ['web [--open]'],
+    summary: 'Show the configured browser surface URL, bind address, and enablement state.',
+    examples: ['web', 'web --open', 'web --hostname 0.0.0.0 --port 3423'],
+  },
+  service: {
+    usage: ['service status', 'service check', 'service install|start|stop|restart|uninstall'],
+    summary: 'Inspect and manage the daemon service lifecycle, autostart, restart policy, PID, logs, and endpoint readiness.',
+    examples: ['service status', 'service check --json', 'service install'],
+  },
+  completion: {
+    usage: ['completion <bash|zsh|fish>'],
+    summary: 'Generate shell completion scripts.',
+    examples: ['completion bash', 'completion zsh'],
+  },
+  serve: {
+    usage: ['serve [--hostname <host>] [--port <port>]', 'daemon [--hostname <host>] [--port <port>]'],
+    summary: 'Start the headless GoodVibes daemon/API host.',
+    examples: ['serve', 'serve --hostname 0.0.0.0 --port 3421'],
+  },
+  remote: {
+    usage: ['remote', 'bridge'],
+    summary: 'Inspect remote runner/node posture and bridge readiness.',
+    examples: ['remote', 'bridge'],
+  },
+};
+
+const HELP_ALIASES: Record<string, string> = {
+  app: 'tui',
+  exec: 'run',
+  setup: 'onboarding',
+  provider: 'providers',
+  model: 'models',
+  subscriptions: 'subscription',
+  secret: 'secrets',
+  session: 'sessions',
+  task: 'tasks',
+  surface: 'surfaces',
+  webhook: 'listener',
+  controlplane: 'control-plane',
+  cp: 'control-plane',
+  qrcode: 'pair',
+  qr: 'pair',
+  daemon: 'serve',
+  server: 'serve',
+  services: 'service',
+  bridge: 'remote',
+};
+
+function normalizeHelpTopic(topic: string): string {
+  const normalized = topic.trim().toLowerCase();
+  return HELP_ALIASES[normalized] ?? normalized;
+}
+
+export function renderGoodVibesCommandHelp(topic: string, binary = 'goodvibes'): string {
+  const normalized = normalizeHelpTopic(topic);
+  const help = COMMAND_HELP[normalized];
+  if (!help) {
+    return [
+      `No detailed help is available for "${topic}".`,
+      '',
+      renderGoodVibesHelp(binary),
+    ].join('\n');
+  }
+  return [
+    `GoodVibes ${normalized}`,
+    '',
+    help.summary,
+    '',
+    'Usage:',
+    ...help.usage.map((usage) => `  ${binary} ${usage}`),
+    ...(help.subcommands && help.subcommands.length > 0 ? [
+      '',
+      'Subcommands:',
+      ...help.subcommands.map((subcommand) => `  ${subcommand}`),
+    ] : []),
+    ...(help.examples && help.examples.length > 0 ? [
+      '',
+      'Examples:',
+      ...help.examples.map((example) => `  ${binary}${example ? ` ${example}` : ''}`),
+    ] : []),
+  ].join('\n');
+}
+
+export function renderGoodVibesDaemonHelp(binary = 'goodvibes-daemon'): string {
+  return [
+    `Usage: ${binary} [OPTIONS]`,
+    '',
+    'Starts the headless GoodVibes daemon/API host.',
+    '',
+    'Options:',
+    '      --daemon-home <dir>        Override daemon home',
+    '      --working-dir <dir>        Override working directory',
+    '  -C, --cd <dir>                 Alias for --working-dir',
+    '      --provider <id>            Override provider',
+    '  -m, --model <registryKey>      Override model. provider:model infers --provider',
+    '      --hostname <host>          Hostname hint for printed connection info',
+    '      --port <port>              Control-plane port override when supported',
+    '  -h, --help                     Print help',
+    '  -v, --version                  Print version',
+  ].join('\n');
+}

package/src/cli/index.ts

@@ -0,0 +1,11 @@
+export * from './types.ts';
+export * from './parser.ts';
+export * from './help.ts';
+export * from './status.ts';
+export * from './completion.ts';
+export * from './config-overrides.ts';
+export * from './endpoints.ts';
+export * from './surface-command.ts';
+export * from './service-command.ts';
+export * from './bundle-command.ts';
+export * from './management.ts';