@braingrid/cli 0.2.12 → 0.2.13

package/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.2.13] - 2025-12-08
+
+### Added
+
+- **Shell tab completion support**
+  - Added `braingrid completion` command to generate shell completion scripts
+  - Support for bash and zsh shells (fish support planned for future release)
+  - Automated setup with `braingrid completion --setup` flag
+  - Auto-detects shell from `$SHELL` environment variable
+  - Completes commands, subcommands, options, and values
+  - Includes status values (IDEA, PLANNED, IN_PROGRESS, REVIEW, COMPLETED, CANCELLED)
+  - Includes format options (table, json, xml, markdown)
+  - Comprehensive documentation in README.md with installation instructions
+  - Uses omelette library for cross-shell compatibility
+
 ## [0.2.12] - 2025-12-05
 
 ### Changed

package/README.md

@@ -258,6 +258,67 @@ braingrid --help       # Show help information
 
 ---
 
+## Shell Completion
+
+BrainGrid CLI supports tab completion for bash and zsh shells, making it faster to type commands and discover available options.
+
+### Quick Setup (Recommended)
+
+Automatically install completion for your current shell:
+
+```bash
+braingrid completion --setup
+```
+
+Then restart your terminal or source your shell config:
+
+```bash
+# For bash
+source ~/.bashrc
+
+# For zsh
+source ~/.zshrc
+```
+
+### Manual Installation
+
+#### Bash
+
+Add to your `~/.bashrc`:
+
+```bash
+# Option 1: Add to shell config
+braingrid completion bash >> ~/.bashrc
+
+# Option 2: Eval in current session (temporary)
+eval "$(braingrid completion bash)"
+```
+
+#### Zsh
+
+Add to your `~/.zshrc`:
+
+```bash
+# Option 1: Add to shell config
+braingrid completion zsh >> ~/.zshrc
+
+# Option 2: Eval in current session (temporary)
+eval "$(braingrid completion zsh)"
+```
+
+### What Gets Completed
+
+- **Commands**: `login`, `logout`, `project`, `requirement`, `task`, etc.
+- **Subcommands**: `list`, `show`, `create`, `update`, `delete`, `breakdown`, `build`
+- **Options**: `--help`, `--format`, `--status`, `--project`, `--requirement`
+- **Values**: Status values (`IDEA`, `PLANNED`, `IN_PROGRESS`, etc.), format options (`table`, `json`, `xml`, `markdown`)
+
+### Fish Shell
+
+Fish shell support is planned for a future release.
+
+---
+
 ## Updating
 
 Update to the latest version:

package/dist/cli.js

@@ -422,7 +422,7 @@ import axios3, { AxiosError as AxiosError2 } from "axios";
 
 // src/build-config.ts
 var BUILD_ENV = true ? "production" : process.env.NODE_ENV === "test" ? "development" : "production";
-var CLI_VERSION = true ? "0.2.12" : "0.0.0-test";
+var CLI_VERSION = true ? "0.2.13" : "0.0.0-test";
 var PRODUCTION_CONFIG = {
   apiUrl: "https://app.braingrid.ai",
   workosAuthUrl: "https://auth.braingrid.ai",
@@ -6670,9 +6670,162 @@ async function handleUpdate(opts) {
   }
 }
 
+// src/handlers/completion.handlers.ts
+import chalk15 from "chalk";
+
+// src/completion/index.ts
+import omelette from "omelette";
+import { homedir } from "os";
+import { join as join3 } from "path";
+var SUPPORTED_SHELLS = ["bash", "zsh"];
+function createCompletion() {
+  const completion = omelette("braingrid <command> <subcommand>");
+  completion.on("command", ({ reply }) => {
+    reply([
+      "login",
+      "logout",
+      "whoami",
+      "status",
+      "init",
+      "update",
+      "specify",
+      "setup",
+      "project",
+      "requirement",
+      "task",
+      "completion"
+    ]);
+  });
+  completion.on("setup", ({ reply }) => {
+    reply(["claude-code", "cursor"]);
+  });
+  completion.on("project", ({ reply }) => {
+    reply(["list", "show", "create", "update", "delete"]);
+  });
+  completion.on("requirement", ({ reply }) => {
+    reply(["list", "show", "create", "update", "delete", "breakdown", "build"]);
+  });
+  completion.on("task", ({ reply }) => {
+    reply(["list", "summary", "show", "create", "update", "delete"]);
+  });
+  completion.on("completion", ({ reply }) => {
+    reply(["bash", "zsh"]);
+  });
+  return completion;
+}
+function initCompletion() {
+  const completion = createCompletion();
+  completion.init();
+}
+function detectShell() {
+  const shellPath = process.env.SHELL || "";
+  const shellName = shellPath.split("/").pop()?.toLowerCase();
+  if (shellName === "bash" || shellName === "zsh") {
+    return shellName;
+  }
+  return null;
+}
+function getShellConfigPath(shell) {
+  const home = homedir();
+  switch (shell) {
+    case "bash":
+      return join3(home, ".bashrc");
+    case "zsh":
+      return join3(home, ".zshrc");
+  }
+}
+function generateCompletionScript(shell) {
+  const completion = createCompletion();
+  return completion.setupShellInitFile(shell);
+}
+function setupCompletion(shell) {
+  const completion = createCompletion();
+  completion.setupShellInitFile(shell);
+}
+
+// src/handlers/completion.handlers.ts
+function getUnsupportedShellError() {
+  return {
+    success: false,
+    message: chalk15.red("\u274C Could not detect shell type.\n\n") + chalk15.dim("Please specify a shell:\n") + chalk15.cyan("  braingrid completion bash\n") + chalk15.cyan("  braingrid completion zsh\n\n") + chalk15.dim("Supported shells: bash, zsh")
+  };
+}
+async function handleCompletion(shellArg, opts) {
+  try {
+    let shell = null;
+    if (shellArg) {
+      if (SUPPORTED_SHELLS.includes(shellArg)) {
+        shell = shellArg;
+      } else {
+        return getUnsupportedShellError();
+      }
+    } else if (opts?.shell) {
+      if (SUPPORTED_SHELLS.includes(opts.shell)) {
+        shell = opts.shell;
+      } else {
+        return getUnsupportedShellError();
+      }
+    } else {
+      shell = detectShell();
+    }
+    if (!shell) {
+      return getUnsupportedShellError();
+    }
+    if (opts?.setup) {
+      try {
+        setupCompletion(shell);
+        const configPath = getShellConfigPath(shell);
+        return {
+          success: true,
+          message: chalk15.green(`\u2705 Completion installed for ${shell}
+
+`) + chalk15.dim("To activate in your current shell, run:\n") + chalk15.cyan(`  source ${configPath}
+
+`) + chalk15.dim("Or restart your terminal.")
+        };
+      } catch (error) {
+        return {
+          success: false,
+          message: chalk15.red("\u274C Failed to install completion\n\n") + chalk15.dim("Error: ") + formatError(error)
+        };
+      }
+    }
+    try {
+      const script = generateCompletionScript(shell);
+      const configPath = getShellConfigPath(shell);
+      const instructions = chalk15.blue(`# BrainGrid CLI completion for ${shell}
+`) + chalk15.dim("# To install, run one of the following:\n\n") + chalk15.cyan(`# 1. Automatic installation (recommended):
+`) + chalk15.cyan(`   braingrid completion --setup
+
+`) + chalk15.cyan(`# 2. Add to your shell config:
+`) + chalk15.cyan(`   braingrid completion ${shell} >> ${configPath}
+
+`) + chalk15.cyan(`# 3. Source directly (temporary, current session only):
+`) + chalk15.cyan(`   eval "$(braingrid completion ${shell})"
+
+`) + chalk15.dim("# Completion script:\n\n");
+      return {
+        success: true,
+        message: instructions + script
+      };
+    } catch (error) {
+      return {
+        success: false,
+        message: chalk15.red("\u274C Failed to generate completion script\n\n") + chalk15.dim("Error: ") + formatError(error)
+      };
+    }
+  } catch (error) {
+    return {
+      success: false,
+      message: formatError(error)
+    };
+  }
+}
+
 // src/cli.ts
 var require2 = createRequire(import.meta.url);
 var packageJson = require2("../package.json");
+initCompletion();
 var program = new Command();
 program.name("braingrid").description("BrainGrid CLI - Manage projects, requirements, and tasks").version(packageJson.version, "-v, --version", "output the current version").showHelpAfterError("(use --help for usage)");
 program.command("login").description("Authenticate with BrainGrid").action(async () => {
@@ -6896,5 +7049,12 @@ task.command("delete <id>").description("Delete a task").option("-r, --requireme
     process.exit(1);
   }
 });
+program.command("completion [shell]").description("Generate shell completion script (bash, zsh)").option("--setup", "automatically install completion for current shell").option("-s, --shell <shell>", "shell type (bash, zsh)").action(async (shell, opts) => {
+  const result = await handleCompletion(shell, opts);
+  console.log(result.message);
+  if (!result.success) {
+    process.exit(1);
+  }
+});
 program.parse();
 //# sourceMappingURL=cli.js.map