feat: update CLI code base to use latest major version of the Go API client (#178)

Author: kai687

.envrc

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+eval "$(devbox generate direnv --print-envrc)"
+
+# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
+# for more details

.github/workflows/api-specs-pr.yml

@@ -2,19 +2,19 @@ name: Scheduled API Specs Pull Request
 on:
   schedule:
     - cron: '0 */12 * * *'
-
 jobs:
   api-specs-pr:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.19
-      - run: |
-          git config --global user.name "algolia-ci"
-          git config --global user.email "[email protected]"
+          go-version: 1.23
       - run: make api-specs-pr
         env:
-          GH_TOKEN: ${{ secrets.GH_SECRET }}
+          GH_TOKEN: ${{ secrets.GH_SECRET }}
+          GIT_COMMITTER_NAME: algolia-ci
+          GIT_AUTHOR_NAME: algolia-ci
+          GIT_COMMITTER_EMAIL: [email protected]
+          GIT_AUTHOR_EMAIL: [email protected]

.github/workflows/go.yml

@@ -1,24 +1,19 @@
 name: Go
-
 on:
   push:
     branches: [main]
   pull_request:
     branches: [main]
-
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.19
-
+          go-version: 1.23
       - name: Build
         run: go build -v ./...
-
       - name: Test
         run: go test -v ./...

.github/workflows/golangci-lint.yml

@@ -14,31 +14,11 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.18
-      - uses: actions/checkout@v3
+          go-version: 1.23
+      - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v6
         with:
-          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.47.3
-
-          # Optional: working directory, useful for monorepos
-          # working-directory: somedir
-
-          # Optional: golangci-lint command line arguments.
-          # args: --issues-exit-code=0
-
-          # Optional: show only new issues if it's a pull request. The default value is `false`.
-          # only-new-issues: true
-
-          # Optional: if set to true then the all caching functionality will be complete disabled,
-          #           takes precedence over all other caching options.
-          # skip-cache: true
-
-          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
-          # skip-pkg-cache: true
-
-          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
-          # skip-build-cache: true
+          version: v1.63.4

.github/workflows/releases.yml

@@ -1,25 +1,22 @@
 name: goreleaser
-
 on:
   push:
     tags:
       - "v*"
-
 permissions:
-  contents: write  # publishing releases
-
+  contents: write # publishing releases
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Code checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.19
+          go-version: 1.23
       - name: Install chocolatey
         run: |
           mkdir -p /opt/chocolatey
@@ -30,15 +27,15 @@ jobs:
         env:
           CHOCOLATEY_VERSION: 1.2.0
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2.8.0
+        uses: goreleaser/goreleaser-action@v6
         with:
-          version: "~1.13.1"
+          version: "~> v2"
           args: release
         env:
           GITHUB_TOKEN: ${{ secrets.GORELEASER_GITHUB_TOKEN }}
           CHOCOLATEY_API_KEY: ${{ secrets.CHOCOLATEY_API_KEY }}
       - name: Docs checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: algolia/doc
           path: docs
@@ -53,4 +50,3 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GORELEASER_GITHUB_TOKEN }}
         run: |
           make docs-pr
-          make VARIATON=new docs-pr

.gitignore

@@ -18,5 +18,5 @@ vendor/
 # local build
 algolia
 
-# Ignore docs directory
-docs/
+# Environment variables
+*.env

.golangci.yml

@@ -0,0 +1,5 @@
+linters:
+  enable:
+    - gosec
+    - gofumpt
+    - stylecheck

Dockerfile

@@ -1,5 +1,14 @@
-FROM alpine
-RUN apk update && apk upgrade && \
-  apk add --no-cache ca-certificates
-COPY algolia /bin/algolia
-ENTRYPOINT ["/bin/algolia"]
+# Build the binary
+FROM golang:1.23-alpine AS builder
+WORKDIR /app
+COPY . .
+ARG VERSION=docker
+RUN apk update && apk add --no-cache curl
+RUN go mod download
+RUN go install github.com/go-task/task/v3/cmd/task@latest
+RUN task download-spec-file && VERSION=${VERSION} task build
+
+FROM alpine:3
+RUN apk update && apk upgrade && apk add --no-cache ca-certificates 
+COPY --from=builder /app/algolia /bin/algolia
+ENTRYPOINT ["/bin/algolia"]

README.md

@@ -1,49 +1,69 @@
 # Algolia CLI
 
-A command line interface to enable Algolia developers to interact with and configure their Algolia applications straight from a command line or terminal window. Automate common workloads, create snapshots, revert to backups, or quickly modify applications as needed! This is a lightweight tool, providing a text-only interface, that is easy to install and use!
+The Algolia CLI lets you work with your Algolia resources,
+such as indices, records, API keys, and synonyms,
+and from the command line.
 
 ![cli](https://user-images.githubusercontent.com/5702266/153008646-1fd8fbf2-4a4d-4421-b2f2-0886487f3e27.png)
 
 ## Documentation
 
-See the [documentation](https://algolia.com/doc/tools/cli/) for setup and usage instructions.
+See [Algolia CLI](https://algolia.com/doc/tools/cli/) in the Algolia documentation for setup and usage instructions.
 
 ## Installation
 
-### Build from Source
+### macOS
 
-A `Makefile` is available to help installing and building the CLI.
+The Algolia CLI is available on [Homebrew](https://brew.sh/) and as a downloadable binary from the [releases page](https://github.com/algolia/cli/releases).
 
-```bash
-git clone [email protected]:algolia/cli.git && make install
+```sh
+brew install algolia/algolia-cli/algolia
 ```
 
-### MacOS
+### Linux
 
-`algolia` is available on Homebrew and as a downloadable binary from the [releases page](https://github.com/algolia/cli/releases).
+The Algolia CLI is available as a `.deb` package:
 
-```bash
-brew tap algolia/algolia-cli && brew install algolia
+```sh
+# Select the package appropriate for your platform:
+sudo dpkg -i algolia_*.deb
+```
+
+as a `.rpm` package:
+
+```sh
+# Select the package appropriate for your platform
+sudo rpm -i algolia_*.rpm
+```
+
+or as a tarball from the [releases page](https://github.com/algolia/cli/releases):
+
+```sh
+# Select the archive appropriate for your platform
+tar xvf algolia_*_linux_*.tar.gz
 ```
 
 ### Windows
 
-`algolia` is available via [Chocolatey](https://community.chocolatey.org/packages/algolia/) and as downloadable .exe files.
+The Algolia CLI is available via [Chocolatey](https://community.chocolatey.org/packages/algolia/) and as a downloadable binary from the [releases page](https://github.com/algolia/cli/releases)
 
-#### Chocolatey
+### Community packages
 
-| Install:           | Upgrade:           |
-| ------------------ | ------------------ |
-| `choco install algolia` | `choco upgrade algolia` |
+Other packages are maintained by the community, not by Algolia.
+If you distribute a package for the Algolia CLI, create a pull request so that we can list it here!
 
-#### Executable
+### Build from source
 
-Executable files are available on the [releases page](https://github.com/algolia/cli/releases).
+To build the Algolia CLI from source, you'll need:
 
-### Other platforms
+- Go version 1.23 or later
+- [Go task](https://taskfile.dev/)
 
-Download packaged binaries from the [releases page](https://github.com/algolia/cli/releases).
+1. Clone the repo: `git clone https://github.com/kai687/cli.git algolia-cli && cd algolia-cli`
+1. Run: `task build`
 
 ## Support
 
-Found a bug on the CLI? [Open a new issue](https://github.com/algolia/cli/issues/new) or [contact the support](https://www.algolia.com/support/) to get help with Algolia!
+If you found an issue with the Algolia CLI,
+[open a new GitHub issue](https://github.com/algolia/cli/issues/new),
+or join the Algolia community on [Discord](https://alg.li/discord).