Merge pull request #1798 from appwrite/refactor/cli-go-codebase

Make the CLI target the Go implementation

Author: ChiragAgg5k

.github/workflows/ci.yml

@@ -21,10 +21,9 @@ jobs:
         sdk: [
           Android5Java17,
           Android16Java17,
-          CLIBun10,
-          CLIBun11,
-          CLIBun13,
-          GoCLI126,
+          CLIGo126,
+          CLIWasm,
+          CLIWasmBrowser,
           DartBeta,
           DartStable,
           DotNet60,

.github/workflows/validation.yml

@@ -11,10 +11,6 @@ jobs:
     name: ${{ matrix.sdk }} (${{ matrix.platform }})
     runs-on: ubuntu-latest
     env:
-      # Bun 1.3.12 has a sig_size calculation bug in macho.zig that truncates the
-      # LC_CODE_SIGNATURE blob on cross-compiled Darwin binaries (oven-sh/bun#29120).
-      # Unpin once a Bun release includes the upstream fix (oven-sh/bun#29122).
-      CLI_BUN_VERSION: '1.3.11'
       FLUTTER_VERSION: '3.35.7'
       OSV_SCANNER_VERSION: 'v2.3.1'
     strategy:
@@ -76,9 +72,6 @@ jobs:
           - sdk: cli
             platform: console
 
-          - sdk: go-cli
-            platform: console
-          
           - sdk: web
             platform: console
 
@@ -101,7 +94,7 @@ jobs:
         run: php example.php ${{ matrix.sdk }} ${{ matrix.platform }}
 
       - name: Verify generated SDK is idempotent
-        if: matrix.sdk == 'zed-extension' || matrix.sdk == 'go-cli'
+        if: matrix.sdk == 'zed-extension' || matrix.sdk == 'cli'
         run: |
           checksums() {
             find examples/${{ matrix.sdk }} -type f -print0 \
@@ -122,12 +115,6 @@ jobs:
         with:
           node-version: '22'
 
-      - name: Setup Bun
-        if: matrix.sdk == 'cli'
-        uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2.2.0
-        with:
-          bun-version: ${{ env.CLI_BUN_VERSION }}
-
       - name: Cache Flutter SDK
         if: matrix.sdk == 'flutter'
         uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
@@ -180,7 +167,7 @@ jobs:
           sdk: 'stable'
 
       - name: Setup Go
-        if: matrix.sdk == 'go' || matrix.sdk == 'go-cli' || matrix.sdk == 'dart' || matrix.sdk == 'flutter'
+        if: matrix.sdk == 'go' || matrix.sdk == 'cli' || matrix.sdk == 'dart' || matrix.sdk == 'flutter'
         uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0
         with:
           go-version: '1.26.6'
@@ -227,18 +214,17 @@ jobs:
               npm run build
               ;;
             cli)
-              bun install
-              bun run linux-x64
-              bun run linux-arm64
-              bun run mac-x64
-              bun run mac-arm64
-              bun run windows-x64
-              bun run windows-arm64
-
-              npm ci
-              npm audit
-              npm run build
-              node dist/cli.cjs --help
+              go mod tidy
+              unformatted=$(gofmt -l .)
+              if [ -n "$unformatted" ]; then
+                echo "Not gofmt-clean:"
+                echo "$unformatted"
+                exit 1
+              fi
+              go build ./...
+              go vet ./...
+              go test -race ./...
+              go build -o appwrite .
               ;;
             react-native)
               npm ci --omit=peer
@@ -298,19 +284,6 @@ jobs:
               go build ./...
               go test ./...
               ;;
-            go-cli)
-              go mod tidy
-              unformatted=$(gofmt -l .)
-              if [ -n "$unformatted" ]; then
-                echo "Not gofmt-clean:"
-                echo "$unformatted"
-                exit 1
-              fi
-              go build ./...
-              go vet ./...
-              go test -race ./...
-              go build -o appwrite .
-              ;;
             dotnet)
               dotnet restore
               dotnet build --no-restore
@@ -335,34 +308,53 @@ jobs:
               ;;
           esac
 
-      - name: Verify CLI Darwin binaries include valid embedded code signatures
-        if: matrix.sdk == 'cli'
-        working-directory: examples/cli
-        run: python3 ../../scripts/verify-darwin-signatures.py
-
       - name: Test compiled CLI binary
         if: matrix.sdk == 'cli'
         working-directory: examples/cli
-        run: |
-          BIN=build/appwrite-cli-linux-x64
-          "./$BIN" --version
-          # The root screen is grouped by intent, so assert a section renders
-          # rather than just that some help was produced.
-          "./$BIN" --help | grep -q "USAGE"
-          "./$BIN" --help | grep -q "GET STARTED"
-          SHELL=bash "./$BIN" completion bash >/dev/null
-
-      - name: Test compiled Go CLI binary
-        if: matrix.sdk == 'go-cli'
-        working-directory: examples/go-cli
         run: |
           ./appwrite --version
           ./appwrite --help | grep -q "USAGE"
           ./appwrite --help | grep -q "GET STARTED"
           SHELL=bash ./appwrite completion bash >/dev/null
 
+      # The CLI ships as a native binary behind an npm launcher, so it has no
+      # dist/ entry points to check -- what can break is the launcher itself
+      # and the two scripts that assemble the platform packages.
+      - name: Verify CLI npm launcher
+        if: matrix.sdk == 'cli'
+        working-directory: examples/cli
+        run: |
+          node --check npm/run.js
+          node --check scripts/build-npm-packages.mjs
+          node --check scripts/stage-assets.mjs
+
+          node -e "
+            const pkg = require('./npm/package.json');
+            const commands = Object.keys(pkg.bin ?? {});
+            if (commands.length !== 1 || pkg.bin[commands[0]] !== 'run.js') {
+              console.error('ERROR: npm/package.json must map exactly one bin command to run.js');
+              process.exit(1);
+            }
+            if (!(pkg.files ?? []).includes('run.js')) {
+              console.error('ERROR: npm/package.json files must include run.js or the launcher is not published');
+              process.exit(1);
+            }
+            if (!pkg.license) {
+              console.error('ERROR: npm/package.json is missing a license');
+              process.exit(1);
+            }
+            for (const [name, version] of Object.entries(pkg.optionalDependencies ?? {})) {
+              if (version !== pkg.version) {
+                console.error(\`ERROR: \${name} is pinned to \${version}, not the launcher version \${pkg.version}\`);
+                process.exit(1);
+              }
+            }
+          "
+
+          (cd npm && npm pack --dry-run)
+
       - name: Verify npm package entry points
-        if: matrix.sdk == 'web' || matrix.sdk == 'node' || matrix.sdk == 'react-native' || matrix.sdk == 'cli'
+        if: matrix.sdk == 'web' || matrix.sdk == 'node' || matrix.sdk == 'react-native'
         working-directory: examples/${{ matrix.sdk }}
         run: |
           echo "::group::Checking package.json has files field"

.gitignore

@@ -28,8 +28,6 @@ templates/swift/example/Example.xcodeproj/xcuserdata
 go.sum
 
 # exclude raw lock files in templates (use .twig versions instead)
-templates/cli/package-lock.json
-templates/cli/bun.lock
 
 # Written by the CLI conformance harness when it runs in place.
 tests/e2e/languages/cli/appwrite.config.json

AGENTS.md

@@ -16,32 +16,25 @@ The generator does not auto-discover templates. Every output file must have an e
 
 | Parent | Children affected |
 |--------|------------------|
-| `Node` | `CLI`, `ReactNative` |
+| `Node` | `ReactNative` |
 | `Dart` | `Flutter` |
 | `Swift` | `Apple` |
 | `Kotlin` | `Android` |
-| `Go` | `GoCLI` |
+| `Go` | `CLI` |
 
 Modifying a parent's template or `getFiles()` affects all children. Regenerate and verify child SDKs too.
 
-**Two couplings are not visible in the hierarchy.**
+**One coupling is not visible in the hierarchy.**
 
-`Concern/CliCommandSurface.php` is a trait used by **both** `CLI` and `GoCLI`. It holds
-the nine helpers that decide what a generated command looks like — flag syntax, query
-flags, promoted root commands, service scopes. It is shared precisely so the two CLIs
-cannot drift, which means a change there alters the TypeScript CLI and the Go CLI at once.
+`templates/cli/install.sh.twig` and `templates/cli/install.ps1.twig` build every download
+URL from `language.params.npmPackage`. The same parameter names release assets produced
+by `.goreleaser.yaml` and consumed by the Scoop manifest and npm platform packages.
+Change the asset naming in one place and all four must move together.
 
-`templates/cli/install.sh.twig` and `templates/cli/install.ps1.twig` live under
-`templates/cli/` but are registered in **both** `CLI::getFiles()` and `GoCLI::getFiles()`.
-They build every download URL from `language.params.npmPackage`, which also names every
-release asset produced by `.goreleaser.yaml` and consumed by the scoop manifest and the
-npm platform packages. Change the asset naming in one place and all four must move
-together, for both CLIs.
-
-Either way, regenerate both:
+Regenerate the CLI after changing any of them:
 
 ```bash
-php example.php cli && php example.php go-cli
+php example.php cli
 ```
 
 ### Rule 4: `copy` scope = no Twig processing
@@ -57,14 +50,13 @@ The `destination` string in each `getFiles()` entry supports Twig expressions an
 
 ### Rule 6: Never modify lock file templates directly
 
-Lock file templates (`package-lock.json.twig`, `bun.lock.twig`) contain Twig expressions that get corrupted if you copy a raw lock file over them. Always use the update script:
+Lock file templates (`package-lock.json.twig`) contain Twig expressions that get corrupted if you copy a raw lock file over them. Always use the update script:
 
 ```bash
-./scripts/update-lockfiles.sh cli    # update CLI lock files only
-./scripts/update-lockfiles.sh all    # update all TS-based SDK lock files
+./scripts/update-lockfiles.sh all
 ```
 
-The script strips Twig expressions before running `npm install`/`bun install`, then restores them automatically. Never run `cp package-lock.json package-lock.json.twig` or edit these files by hand.
+The script strips Twig expressions before running `npm install`, then restores them automatically. Never copy a raw lock file over a lock template or edit one by hand.
 
 ## Repository at a Glance
 
@@ -80,7 +72,7 @@ examples/<lang>/              ← Generated SDK output (gitignored; regenerate t
 example.php                   ← Entry point: regenerates all SDKs from specs
 ```
 
-**Supported SDKs:** PHP, Web, Node, CLI, GoCLI, Ruby, Python, Dart, Flutter, React Native, Go, Swift, Apple, DotNet, Android, Kotlin, Unity, REST, GraphQL, Rust, Skills, CursorPlugin, ClaudePlugin, CodexPlugin
+**Supported SDKs:** PHP, Web, Node, CLI, Ruby, Python, Dart, Flutter, React Native, Go, Swift, Apple, DotNet, Android, Kotlin, Unity, REST, GraphQL, Rust, Skills, CursorPlugin, ClaudePlugin, CodexPlugin
 
 ## Primary Workflows
 
@@ -172,7 +164,6 @@ Pass as first argument to generate only that SDK:
 | `flutter` | Flutter | `examples/flutter/` |
 | `react-native` | ReactNative | `examples/react-native/` |
 | `go` | Go | `examples/go/` |
-| `go-cli` | GoCLI | `examples/go-cli/` |
 | `swift` | Swift | `examples/swift/` |
 | `apple` | Apple | `examples/apple/` |
 | `dotnet` | DotNet | `examples/dotnet/` |
@@ -242,8 +233,6 @@ Before submitting changes that touch templates or language classes:
 - [ ] Rector check passes (`composer refactor:check`)
 - [ ] Twig linter passes (`composer lint-twig`)
 - [ ] If a parent language was modified, child SDKs were also checked
-- [ ] If `Concern/CliCommandSurface.php` was touched, **both** CLIs were regenerated and
-      their e2e suites run — the trait is shared, so a change there moves the shipping
-      TypeScript CLI as well as the Go one
-- [ ] Go CLI changes compile and pass their tests:
-      `cd examples/go-cli && go build ./... && go vet ./... && go test ./...`
+- [ ] If `Concern/CliCommandSurface.php` was touched, the CLI was regenerated and its e2e suite run
+- [ ] CLI changes compile and pass their tests:
+      `cd examples/cli && go build ./... && go vet ./... && go test ./...`

README.md

@@ -183,7 +183,7 @@ php example.php zed-extension
 
 | Target | Argument | Supported Versions | Coding Standards | Package Manager | Output |
 |--------|----------|--------------------|------------------|-----------------|--------|
-| CLI | `cli` | Node.js 20 and Bun 1.3.11 in CI | [NPM Coding Style] | NPM, Bun, native binaries | `examples/cli/` |
+| CLI | `cli` | Go 1.26.5 | [Effective Go] | Go modules, native binaries, NPM | `examples/cli/` |
 | REST examples | `rest` | N/A | Markdown | N/A | `examples/REST/` |
 | GraphQL | `graphql` | N/A | GraphQL | N/A | `examples/graphql/` |
 | Skills | `skills` | N/A | Markdown | N/A | `examples/skills/` |

example.php

@@ -9,7 +9,6 @@
 use Appwrite\SDK\Language\Web;
 use Appwrite\SDK\Language\Node;
 use Appwrite\SDK\Language\CLI;
-use Appwrite\SDK\Language\GoCLI;
 use Appwrite\SDK\Language\PHP;
 use Appwrite\SDK\Language\Python;
 use Appwrite\SDK\Language\Ruby;
@@ -65,6 +64,7 @@ function configureSDK(SDK $sdk, array $overrides = []): SDK {
             'shortDescription' => 'Repo short description goes here',
             'url' => 'https://example.com',
             'coverImage' => Config::COVER_IMAGE,
+            'license' => 'BSD-3-Clause',
             'licenseContent' => 'test test test',
             'warning' => '**WORK IN PROGRESS - NOT READY FOR USAGE**',
             'changelog' => '**CHANGELOG**',
@@ -97,6 +97,7 @@ function configureSDK(SDK $sdk, array $overrides = []): SDK {
             ->setShortDescription($config['shortDescription'])
             ->setURL($config['url'])
             ->setCoverImage($config['coverImage'])
+            ->setLicense($config['license'])
             ->setLicenseContent($config['licenseContent'])
             ->setWarning($config['warning'])
             ->setChangelog($config['changelog'])
@@ -160,7 +161,6 @@ function buildStaticSpecification(): Specification {
         'web',
         'node',
         'cli',
-        'go-cli',
         'ruby',
         'python',
         'dart',
@@ -261,7 +261,6 @@ function buildStaticSpecification(): Specification {
   \_/ \_/ .__/| .__/ \_/\_/ |_|  |_|\__\___| \____/\____/\____/
         |_|   |_|                                                ";
 
-    // Shared by both CLIs: they present the same command surface.
     $cliExcludes = [
         'services' => [
             ['name' => 'assistant'],
@@ -308,18 +307,17 @@ function buildStaticSpecification(): Specification {
     // Absent from the published Go SDK, which is generated from the server spec:
     // three console-only services, plus `migrations`, which has never shipped.
     // Generating their commands would import packages that do not exist.
-    $goCliExcludes             = $cliExcludes;
-    $goCliExcludes['services'] = [
-        ...$goCliExcludes['services'],
+    $cliExcludes['services'] = [
+        ...$cliExcludes['services'],
         ['name' => 'affiliates'],
         ['name' => 'migrations'],
         ['name' => 'notifications'],
         ['name' => 'vcs'],
     ];
     // Individual endpoints the same SDK has no function for. Read off the
     // compiler, not guessed -- an invented name silently matches nothing.
-    $goCliExcludes['methods'] = [
-        ...$goCliExcludes['methods'],
+    $cliExcludes['methods'] = [
+        ...$cliExcludes['methods'],
         // Account API keys and push targets, and account deletion.
         ['service' => 'account', 'name' => 'createKey'],
         ['service' => 'account', 'name' => 'listKeys'],
@@ -357,37 +355,19 @@ function buildStaticSpecification(): Specification {
 
     // CLI
     if (!$requestedSdk || $requestedSdk === 'cli') {
-        $language  = new CLI();
-        $language->setNPMPackage('appwrite-cli');
-        $language->setExecutableName('appwrite');
-        $language->setLogo(json_encode($cliLogo));
-        $language->setLogoUnescaped($cliLogoUnescaped);
-
-        $sdk  = new SDK($language, buildSpecification($spec));
-        $sdk->setTest(false);
-        configureSDK($sdk, [
-            'exclude' => $cliExcludes,
-        ]);
-
-        $sdk->generate(__DIR__ . '/examples/cli');
-    }
-
-    // Go CLI -- shares the TypeScript CLI's command surface via CliCommandSurface.
-    if (!$requestedSdk || $requestedSdk === 'go-cli') {
-        $language = new GoCLI();
+        $language = new CLI();
         $language->setExecutableName('appwrite');
         $language->setLogo($cliLogo);
         $language->setLogoUnescaped($cliLogoUnescaped);
-        // Same package as the TypeScript CLI, and it names every release asset.
         $language->setNPMPackage('appwrite-cli');
 
         $sdk = new SDK($language, buildSpecification($spec));
         $sdk->setTest(false);
         configureSDK($sdk, [
-            'exclude' => $goCliExcludes,
+            'exclude' => $cliExcludes,
         ]);
 
-        $sdk->generate(__DIR__ . '/examples/go-cli');
+        $sdk->generate(__DIR__ . '/examples/cli');
     }
 
     // Ruby