hexbus 0.1.0 → 0.1.1

package/README.md

@@ -1,17 +1,140 @@
 # hexbus
 
-Reusable CLI chassis for Hexbus tools.
+Opinionated CLI framework for Inth apps. `hexbus` gives Inth app CLIs a small, typed foundation for parsing flags, creating execution context, rendering help, reporting errors, logging progress, detecting projects, and showing update hints.
 
-Includes:
+## Table of Contents
 
-- argument parsing and global flags
-- context creation
-- logger and spinner helpers
-- configurable telemetry
-- configurable error catalog
-- project root, framework, and package manager detection
-- intro and help rendering
+- [Key Features](#key-features)
+- [Prerequisites](#prerequisites)
+- [Quick Start](#quick-start)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Global Flags](#global-flags)
+- [Support](#support)
+- [License](#license)
+- [Core Exports](#core-exports)
+- [Context Shape](#context-shape)
+- [Update Checks](#update-checks)
+
+## Key Features
+
+- Typed `CliContext` creation with command metadata, parsed flags, project root, package manager detection, framework detection, file-system helpers, config loading, telemetry, and confirmation prompts.
+- Shared argument parser and global flags for help, version, logging, color, config, confirmation, telemetry, and force behavior.
+- Consistent logger, spinner, intro, help, and error rendering built on top of `@clack/prompts`.
+- Configurable error catalog and best-effort telemetry hooks that Inth app CLIs can extend or disable.
+- Project, framework, package manager, install source, and registry update helpers for better CLI guidance.
+- Test helpers for creating lightweight contexts without standing up a full CLI invocation.
+
+## Prerequisites
+
+- Node.js 18.17.0 or later
+- A TypeScript ESM project
+- Bun, npm, pnpm, or yarn in the consuming project
+
+## Quick Start
+
+Define command metadata, create a context from `process.argv`, then route to the selected command:
 
 ```ts
-import { createCliContext, displayIntro, showHelpMenu } from 'hexbus';
+import {
+  createCliContext,
+  showHelpMenu,
+  globalFlags,
+  type CliCommand,
+} from "hexbus";
+
+const commands: CliCommand[] = [
+  {
+    name: "init",
+    label: "Initialize",
+    hint: "Create project files",
+    description: "Initialize project files.",
+    async action(context) {
+      context.logger.info(`Project root: ${context.projectRoot}`);
+    },
+  },
+];
+
+const context = await createCliContext({
+  rawArgs: process.argv.slice(2),
+  commands,
+  appName: "my-cli",
+});
+
+if (context.flags.help) {
+  showHelpMenu(
+    context,
+    { appName: "my-cli", version: "0.1.0" },
+    commands,
+    globalFlags
+  );
+  process.exit(0);
+}
+
+const command =
+  commands.find((item) => item.name === context.commandName) ?? commands[0];
+await command.action(context);
+```
+
+## Installation
+
+```bash
+bun add hexbus
+```
+
+```bash
+npm install hexbus
+```
+
+```bash
+pnpm add hexbus
 ```
+
+## Usage
+
+1. Use `parseCliArgs` when you only need normalized command names, command args, and global flags.
+2. Use `createCliContext` when command execution needs the full runtime context.
+3. Use `CliError`, `extendErrorCatalog`, and `withErrorHandling` to keep app-specific failures consistent with shared CLI output.
+4. Use `displayIntro`, `showHelpMenu`, `createSpinner`, and `createCliLogger` for consistent terminal UX.
+5. Use `isVersionRequest`, `printVersionInfo`, and `startBackgroundUpdateCheck` for fast `-v` / `--version` handling and install-source-aware update hints.
+
+## Global Flags
+
+- `--help, -h`: Show the CLI help menu.
+- `--version, -v`: Show the CLI version.
+- `--logger <level>`: Set log level to `error`, `warn`, `info`, or `debug`.
+- `--color / --no-color`: Force or disable color output.
+- `--config <path>`: Specify a configuration file path.
+- `-y, --yes`: Skip confirmation prompts.
+- `--no-telemetry`: Disable telemetry data collection.
+- `--telemetry-debug`: Log telemetry payloads through the debug channel.
+- `--force`: Force an operation even if files exist.
+
+## Support
+
+- Open an issue in the Hexbus repository for bugs or API questions.
+- See `examples/minimal-cli` for a runnable reference CLI.
+
+## License
+
+[Apache-2.0](../../LICENSE)
+
+## Core Exports
+
+- Context: `createCliContext`, `createTestContext`, `CreateContextOptions`
+- Parser: `parseCliArgs`, `parseSubcommand`, `hasFlag`, `getFlagValue`, `globalFlags`
+- Terminal UX: `createCliLogger`, `createSpinner`, `withSpinner`, `displayIntro`, `showHelpMenu`
+- Errors: `CliError`, `createErrorHandlers`, `extendErrorCatalog`, `withErrorHandling`
+- Detection: `detectProjectRoot`, `detectPackageManager`, `detectFramework`, `getInstallCommand`, `getRunCommand`, `getExecCommand`
+- Telemetry: `createTelemetry`, `createDisabledTelemetry`, `TelemetryEventName`
+- Updates: `isVersionRequest`, `printVersionInfo`, `checkForUpdate`, `startBackgroundUpdateCheck`, `formatUpdateHint`
+
+## Context Shape
+
+`createCliContext` resolves the common services command actions usually need: logger, parsed flags, command args, project root, framework metadata, package manager commands, config helpers, file-system helpers, telemetry, confirmation prompts, and shared error handlers.
+
+Inth app CLIs can extend the generic context type when they attach additional services before invoking command actions.
+
+## Update Checks
+
+`hexbus` supports fast version requests before full context creation. Use `isVersionRequest` and `printVersionInfo` for `-v` / `--version`, then call `startBackgroundUpdateCheck` during normal command execution to show cached update hints and refresh stale registry data in the background.