feat: autogenerate CLI command docs

package.json

@@ -15,9 +15,10 @@
     "build:references": "pnpm --filter js-api-generator run build",
     "build:releases": "pnpm --filter releases-generator run build",
     "build:config": "pnpm --filter config-generator run build",
+    "build:cli": "pnpm --filter cli-generator run build",
     "build:astro": "astro build",
     "build:i18n": "pnpm --filter docs-i18n-tracker run build",
-    "build": "pnpm dev:setup && pnpm build:references && pnpm build:config && pnpm build:releases && pnpm build:astro && pnpm build:i18n",
+    "build": "pnpm dev:setup && pnpm build:references && pnpm build:config && pnpm build:cli && pnpm build:releases && pnpm build:astro && pnpm build:i18n",
     "preview": "astro preview"
   },
   "dependencies": {

packages/cli-generator/build.ts

@@ -0,0 +1,100 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { execSync } from 'node:child_process';
+import { slug } from 'github-slugger';
+
+interface Command {
+  name: string;
+  description: string;
+}
+
+function getSubcommands(commandOutput: string): Command[] {
+  const subcommands = [];
+
+  let readingSubcommands = false;
+  for (const line of commandOutput.split('\n').map((l) => l.trim())) {
+    if (readingSubcommands) {
+      if (line.length === 0) {
+        readingSubcommands = false;
+      } else {
+        const subcommand = line.substring(0, line.indexOf(' '));
+        const description = line.substring(subcommand.length).trim();
+        if (subcommand !== 'help') {
+          subcommands.push({ name: subcommand, description });
+        }
+      }
+    }
+    if (line === 'Commands:') {
+      readingSubcommands = true;
+    }
+  }
+
+  return subcommands;
+}
+
+function generateCommandDoc(command: string, level: number, subcommandList: Command[]): string {
+  const output = execSync(`pnpm tauri ${command} --help`)
+    .toString()
+    .replace('pnpm run build', 'tauri');
+  const subcommands = getSubcommands(output);
+
+  subcommandList.push(
+    ...subcommands.map((subcommand) => ({
+      ...subcommand,
+      name: `${command} ${subcommand.name}`,
+    }))
+  );
+
+  const subcommandsDoc =
+    subcommands.length === 0
+      ? ''
+      : `\n${subcommands.map(({ name }) => generateCommandDoc(`${command} ${name}`, level + 1, commandList)).join('\n\n')}`;
+
+  const heading = '#'.repeat(level);
+  return `${heading} \`${command}\`
+
+<CommandTabs
+  npm="npm run tauri ${command}"
+  yarn="yarn tauri ${command}"
+  pnpm="pnpm tauri ${command}"
+  cargo="cargo tauri ${command}"
+/>
+
+\`\`\`
+${output}
+\`\`\`
+${subcommandsDoc}
+`;
+}
+
+const output = execSync('pnpm tauri --help').toString();
+const subcommands = getSubcommands(output);
+
+const commandList: Command[] = [];
+
+let doc = '';
+
+for (const command of subcommands) {
+  commandList.push(command);
+  const commandDoc = generateCommandDoc(command.name, 3, commandList);
+  doc += commandDoc;
+}
+
+let summary = `| Command | Description |
+| ---------- | ------------------- |
+`;
+
+for (const { name, description } of commandList) {
+  summary += `| [\`${name}\`](#${slug(name)}) | ${description} |\n`;
+}
+
+const template = readFileSync('../../src/content/docs/reference/_cli.mdx').toString();
+
+writeFileSync(
+  '../../src/content/docs/reference/cli.mdx',
+  template.replace(
+    '$LIST_OF_COMMANDS',
+    `${summary}
+
+${doc}`
+  )
+);

packages/cli-generator/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "cli-generator",
+  "version": "1.0.0",
+  "private": "true",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "build": "tsm ./build.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@tauri-apps/cli": "2.0.0-rc.3",
+    "@types/node": "^20.11.20",
+    "github-slugger": "^2.0.0",
+    "tsm": "^2.3.0",
+    "typescript": "^5.3.3"
+  }
+}

packages/cli-generator/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

pnpm-workspace.yaml

@@ -2,5 +2,6 @@ packages:
   - 'packages/i18n-tracker'
   - 'packages/js-api-generator'
   - 'packages/config-generator'
+  - 'packages/cli-generator'
   - 'packages/tauri-typedoc-theme'
   - 'packages/releases-generator'

src/content/docs/reference/.gitignore

@@ -1,4 +1,5 @@
 config.md
 acl/*.md
+cli.mdx
 javascript/*
 !javascript/index.mdx

src/content/docs/reference/_cli.mdx

@@ -0,0 +1,32 @@
+---
+title: Command Line Interface
+sidebar:
+  order: 1
+tableOfContents:
+  minHeadingLevel: 2
+  maxHeadingLevel: 5
+---
+
+import { Tabs, TabItem } from '@astrojs/starlight/components';
+import CommandTabs from '@components/CommandTabs.astro';
+
+The Tauri command line interface (CLI) is the way to interact with Tauri throughout the development lifecycle.
+
+You can add the Tauri CLI to your current project using your package manager of choice:
+
+<CommandTabs
+  npm="npm install --save-dev @tauri-apps/cli@next"
+  yarn="yarn add -D @tauri-apps/cli@next"
+  pnpm="pnpm add -D @tauri-apps/cli@next"
+  cargo='cargo install tauri-cli --version "^2.0.0-rc"'
+/>
+
+:::tip[Developing a Plugin]
+
+For CLI commands related to developing plugins visit the [Develop a Tauri Plugin guide](/develop/plugins/).
+
+:::
+
+## List of Commands
+
+$LIST_OF_COMMANDS