Merge pull request #56 from datum-cloud/drewr/nix-flake

feat: Add nix support

Nix flake for datumctl, enabling reproducible builds across multiple
platforms and seamless integration into nix environments.

* flake.nix with automated vendorHash updates
* docs

Benefits:

- Reproducible builds across all supported platforms
- Zero-dependency development environment setup via `nix develop`
- Direct execution without installation via `nix run github:datum-cloud/datumctl`
- Automated vendorHash maintenance via a GitHub Action
- Cross-compilation support for all supported platforms from any platform
- Works seamlessly on NixOS, nix-darwin, and any system with Nix installed

Author: drewr

.github/workflows/nix-update-hash.yaml

@@ -0,0 +1,48 @@
+name: "nix-update-hash"
+on:
+  push:
+    paths:
+      - 'go.mod'
+      - 'go.sum'
+    branches-ignore:
+      - 'nix-update-hash/*'
+
+jobs:
+  update-hash:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install Nix
+        uses: cachix/install-nix-action@v30
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+
+      - name: Install Task
+        uses: arduino/setup-task@v2
+
+      - name: Update Nix vendor hash
+        run: task nix-update-hash
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          commit-message: 'chore(nix): Update vendorHash after Go dependency changes'
+          title: 'chore(nix): Update vendorHash after Go dependency changes'
+          body: |
+            This PR automatically updates the vendorHash in `flake.nix` after changes to Go dependencies.
+
+            Triggered by changes to `go.mod` or `go.sum`.
+
+            🤖 Generated by GitHub Actions
+          branch: nix-update-hash/${{ github.ref_name }}
+          delete-branch: true

.gitignore

@@ -1,2 +1,6 @@
 # Ignore goreleaser output
 dist/
+# Built binary
+/datumctl
+# Nix stuff
+/result

README.md

@@ -19,7 +19,7 @@ Use `datumctl` to manage your Datum Cloud resources, authenticate securely, and
 
 ### Installation
 
-See the [Installation Guide](./docs/user/installation.md) for detailed instructions, including Homebrew for macOS and pre-built binaries for all platforms.
+See the [Installation Guide](./docs/user/installation.md) for detailed instructions, including Homebrew for macOS, nix for Linux and macOS, and pre-built binaries for all platforms.
 
 ### Basic Usage
 

Taskfile.yml

@@ -0,0 +1,37 @@
+version: '3'
+
+tasks:
+  default:
+    desc: Show available tasks
+    cmds:
+      - task --list
+
+  nix-update-hash:
+    desc: Automatically update the vendorHash in flake.nix after Go dependency changes
+    cmds:
+      - go run scripts/update-nix-hash.go
+
+  nix-build:
+    desc: Build the project with Nix
+    cmds:
+      - nix build
+
+  nix-dev:
+    desc: Enter the Nix development shell
+    cmds:
+      - nix develop
+
+  nix-fmt:
+    desc: Format nix files
+    cmds:
+      - nix fmt
+
+  clean:
+    desc: Remove build artifacts
+    cmds:
+      - rm -rf result result-*
+
+  nix-check:
+    desc: Check flake syntax and run checks
+    cmds:
+      - nix flake check

docs/user/installation.md

@@ -18,6 +18,34 @@ brew install datumctl
 brew upgrade datumctl
 ```
 
+## nix (Linux and macOS)
+
+datumctl ships with a `flake.nix` so you don't have to install anything:
+
+```
+# Pick latest from git
+nix run github:datum-cloud/datumctl
+
+# Specify version
+nix run github:datum-cloud/datumctl/b044455d877b800812e4fd78e42429c1617c011b
+
+# Run from local git clone
+nix run
+
+# Start shell with all dependencies available
+nix develop --command zsh
+
+# Build locally
+nix build
+
+# ...or for specific platform
+nix build .#packages.x86_64-linux.default
+nix build .#packages.aarch64-linux.default
+```
+
+You can, however, incorporate it into your home-manager build or other
+flake so that it's always available in your profile.
+
 ## Pre-built binaries (recommended)
 
 The easiest way to install `datumctl` is by downloading the pre-built binary

flake.lock

@@ -0,0 +1,81 @@
+{
+  description = "datumctl - A CLI for interacting with Datum Cloud";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachSystem [
+      "x86_64-linux"
+      "aarch64-linux"
+      "x86_64-darwin"
+      "aarch64-darwin"
+    ] (system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+        };
+
+        # Get version from git, fallback to "dev" if not in a git repo
+        version =
+          if (builtins.pathExists ./.git)
+          then builtins.replaceStrings ["\n"] [""] (builtins.readFile (
+            pkgs.runCommand "get-version" {} ''
+              cd ${./.}
+              ${pkgs.git}/bin/git describe --tags --always --dirty 2>/dev/null > $out || echo "dev" > $out
+            ''
+          ))
+          else "dev";
+
+      in
+      {
+        packages = {
+          default = pkgs.buildGoModule {
+            pname = "datumctl";
+            inherit version;
+
+            src = ./.;
+
+            # Hash of Go module dependencies.
+            # Update this after changing go.mod/go.sum:
+            #   task nix-update-hash
+            vendorHash = "sha256-IZtck6ZsaIoEZLpukWHVbQAhfOsly0WO0OWO+6uRhgE=";
+
+            ldflags = [
+              "-s"
+              "-w"
+              "-X main.version=${version}"
+            ];
+
+            meta = with pkgs.lib; {
+              description = "A CLI for interacting with the Datum platform";
+              homepage = "https://www.datum.net/docs/quickstart/datumctl/";
+              license = licenses.asl20;
+              maintainers = [ ];
+              mainProgram = "datumctl";
+            };
+          };
+        };
+
+        devShells.default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            go_1_25
+            gopls
+            gotools
+            go-task
+            go-tools
+            git
+          ];
+
+          shellHook = ''
+            echo "datumctl development environment"
+            echo "Go version: $(go version)"
+          '';
+        };
+
+        formatter = pkgs.nixpkgs-fmt;
+      }
+    );
+}