@speedkit/cli 4.16.0 → 4.17.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [4.17.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v4.16.0...v4.17.0) (2026-07-17)
+
+
+### Features
+
+* extend autocomplete for fish ([b9d1fcb](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b9d1fcb2fb921ad91895b69aad8f02206ca09cbf))
+
 # [4.16.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v4.15.1...v4.16.0) (2026-07-13)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/4.16.0 linux-x64 node-v22.23.1
+@speedkit/cli/4.17.0 linux-x64 node-v22.23.1
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -67,6 +67,7 @@ By either...
 <!-- commands -->
 * [`sk auto-prewarm CUSTOMERPATH`](#sk-auto-prewarm-customerpath)
 * [`sk autocomplete [SHELL]`](#sk-autocomplete-shell)
+* [`sk autocomplete fish`](#sk-autocomplete-fish)
 * [`sk build-parameter-query CUSTOMERPATH`](#sk-build-parameter-query-customerpath)
 * [`sk build-prewarm-query CUSTOMERPATH`](#sk-build-prewarm-query-customerpath)
 * [`sk config edit`](#sk-config-edit)
@@ -146,6 +147,26 @@ EXAMPLES
 
 _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.49/src/commands/autocomplete/index.ts)_
 
+## `sk autocomplete fish`
+
+Generate fish shell completions and install them to ~/.config/fish/completions.
+
+```
+USAGE
+  $ sk autocomplete fish [-p]
+
+FLAGS
+  -p, --print  Print the completion script to stdout instead of installing it
+
+DESCRIPTION
+  Generate fish shell completions and install them to ~/.config/fish/completions.
+
+EXAMPLES
+  $ sk autocomplete fish
+
+  $ sk autocomplete fish --print > sk.fish
+```
+
 ## `sk build-parameter-query CUSTOMERPATH`
 
 Build a parameter query that can be executed in Athena

package/dist/commands/autocomplete/fish.d.ts

@@ -0,0 +1,19 @@
+import { Command } from "@oclif/core";
+/**
+ * Fish is not supported by @oclif/plugin-autocomplete (only bash, zsh and
+ * powershell), so this command generates a fish completion script from the
+ * oclif command manifest and installs it to ~/.config/fish/completions,
+ * where fish picks it up automatically.
+ */
+export default class AutocompleteFish extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        print: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private generateCompletionScript;
+    private topicDescription;
+    private summarize;
+    private escape;
+}

package/dist/commands/autocomplete/fish.js

@@ -0,0 +1,140 @@
+import { Command, Flags } from "@oclif/core";
+import { mkdir, writeFile } from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
+/**
+ * Fish is not supported by @oclif/plugin-autocomplete (only bash, zsh and
+ * powershell), so this command generates a fish completion script from the
+ * oclif command manifest and installs it to ~/.config/fish/completions,
+ * where fish picks it up automatically.
+ */
+export default class AutocompleteFish extends Command {
+    static description = "Generate fish shell completions and install them to ~/.config/fish/completions.";
+    static examples = [
+        "$ sk autocomplete fish",
+        "$ sk autocomplete fish --print > sk.fish",
+    ];
+    static flags = {
+        print: Flags.boolean({
+            char: "p",
+            description: "Print the completion script to stdout instead of installing it",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AutocompleteFish);
+        const script = this.generateCompletionScript();
+        if (flags.print) {
+            this.log(script);
+            return;
+        }
+        const completionsDir = path.join(process.env.XDG_CONFIG_HOME || path.join(os.homedir(), ".config"), "fish", "completions");
+        const completionFile = path.join(completionsDir, `${this.config.bin}.fish`);
+        await mkdir(completionsDir, { recursive: true });
+        await writeFile(completionFile, script);
+        this.log(`Fish completions written to ${completionFile}`);
+        this.log("New fish sessions pick them up automatically. Rerun this command after updating the CLI.");
+    }
+    generateCompletionScript() {
+        const { bin } = this.config;
+        const fn = bin.replaceAll("-", "_");
+        const commands = this.config.commands
+            .filter((command) => !command.hidden)
+            .sort((a, b) => a.id.localeCompare(b.id));
+        const lines = [
+            `# Fish completions for ${bin} — generated by \`${bin} autocomplete fish\`. Do not edit by hand.`,
+            "",
+            `function __${fn}_at_level`,
+            "    test (count (commandline -opc)) -eq $argv[1]",
+            "end",
+            "",
+            `function __${fn}_using_command`,
+            "    set -l cmd (commandline -opc)",
+            "    set -e cmd[1]",
+            "    set -l expected (string split ' ' -- $argv[1])",
+            "    test (count $cmd) -ge (count $expected); or return 1",
+            "    for i in (seq (count $expected))",
+            '        test "$cmd[$i]" = "$expected[$i]"; or return 1',
+            "    end",
+            "end",
+            "",
+        ];
+        // Command and topic name completions, e.g. `sk dep<TAB>` or `sk config <TAB>`.
+        const seen = new Set();
+        for (const command of commands) {
+            const tokens = command.id.split(":");
+            for (let depth = 1; depth <= tokens.length; depth++) {
+                const token = tokens[depth - 1];
+                const prefix = tokens.slice(0, depth - 1);
+                const key = `${prefix.join(" ")} ${token}`;
+                if (seen.has(key))
+                    continue;
+                seen.add(key);
+                const description = depth === tokens.length
+                    ? this.summarize(command.summary ?? command.description)
+                    : this.topicDescription([...prefix, token].join(":"));
+                const condition = depth === 1
+                    ? `__${fn}_at_level 1`
+                    : `__${fn}_at_level ${depth}; and __${fn}_using_command '${prefix.join(" ")}'`;
+                let entry = `complete -f -c ${bin} -n "${condition}" -a ${token}`;
+                if (description)
+                    entry += ` -d '${this.escape(description)}'`;
+                lines.push(entry);
+            }
+        }
+        // Flag and positional-argument completions per command.
+        for (const command of commands) {
+            const tokens = command.id.split(":");
+            const commandPath = tokens.join(" ");
+            // Don't offer a parent command's flags while a subcommand is being used,
+            // e.g. `sk autocomplete fish` must not suggest `--refresh-cache`.
+            const childPaths = new Set(commands
+                .filter((other) => other.id.startsWith(`${command.id}:`))
+                .map((other) => other.id
+                .split(":")
+                .slice(0, tokens.length + 1)
+                .join(" ")));
+            const condition = [
+                `__${fn}_using_command '${commandPath}'`,
+                ...[...childPaths].map((child) => `and not __${fn}_using_command '${child}'`),
+            ].join("; ");
+            for (const [name, flag] of Object.entries(command.flags ?? {})) {
+                if (flag.hidden)
+                    continue;
+                let entry = `complete -c ${bin} -n "${condition}" -l ${name}`;
+                if (flag.char)
+                    entry += ` -s ${flag.char}`;
+                if (flag.type === "option") {
+                    entry += flag.options?.length
+                        ? ` -rfa '${flag.options.join(" ")}'`
+                        : " -r";
+                }
+                const description = this.summarize(flag.summary ?? flag.description);
+                if (description)
+                    entry += ` -d '${this.escape(description)}'`;
+                lines.push(entry);
+            }
+            // Args with a fixed option set, e.g. the SHELL arg of `sk autocomplete`.
+            Object.values(command.args ?? {}).forEach((arg, index) => {
+                if (arg.hidden || !arg.options?.length)
+                    return;
+                const level = tokens.length + 1 + index;
+                lines.push(`complete -f -c ${bin} -n "__${fn}_at_level ${level}; and ${condition}" -a '${arg.options.join(" ")}'`);
+            });
+        }
+        return lines.join("\n") + "\n";
+    }
+    topicDescription(topicName) {
+        const topic = this.config.topics.find(({ name }) => name === topicName);
+        return this.summarize(topic?.description);
+    }
+    summarize(text) {
+        // Plugin descriptions may contain ejs templates, e.g. "Display help for <%= config.bin %>."
+        return (text ?? "")
+            .split("\n")[0]
+            .replaceAll("<%= config.bin %>", this.config.bin)
+            .trim();
+    }
+    escape(text) {
+        return text.replaceAll("\\", "\\\\").replaceAll("'", "\\'");
+    }
+}

package/oclif.manifest.json

@@ -822,6 +822,39 @@
         "wpt-launcher.js"
       ]
     },
+    "autocomplete:fish": {
+      "aliases": [],
+      "args": {},
+      "description": "Generate fish shell completions and install them to ~/.config/fish/completions.",
+      "examples": [
+        "$ sk autocomplete fish",
+        "$ sk autocomplete fish --print > sk.fish"
+      ],
+      "flags": {
+        "print": {
+          "char": "p",
+          "description": "Print the completion script to stdout instead of installing it",
+          "name": "print",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "autocomplete:fish",
+      "pluginAlias": "@speedkit/cli",
+      "pluginName": "@speedkit/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "autocomplete",
+        "fish.js"
+      ]
+    },
     "config:edit": {
       "aliases": [],
       "args": {},
@@ -847,5 +880,5 @@
       ]
     }
   },
-  "version": "4.16.0"
+  "version": "4.17.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "4.16.0",
+  "version": "4.17.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"