feat: Add dev server (AKA LaunchDevly)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -31,4 +31,4 @@ The version of this CLI that you are using.
 For instance, Ubuntu 16.04, Windows 10, or macOS 14.4.
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-Add any other context about the feature request here.
+Add any other context about the feature request here.

.github/actions/publish/action.yml

@@ -14,6 +14,7 @@ inputs:
   tag:
     description: 'Tag to upload artifacts to.'
     required: true
+
 outputs:
   hashes:
     description: sha256sum hashes of built artifacts
@@ -29,17 +30,45 @@ runs:
       with:
         platforms: linux/amd64,linux/arm64/v8,linux/arm/v7,linux/386
     - name: Login to Docker
+      shell: bash
+      run: echo $DOCKER_TOKEN | docker login --username $DOCKER_USERNAME --password-stdin
+
+    - name: Set up goreleaser
+      # Note: that we're unable to use the normal goreleaser actions and have to use this docker image.
+      # This is because the dev server piece of the CLI uses SQLite which requires CGO and cross compilation.
+      # We're using the goreleaser-cross image to facilitate this. See also: https://github.com/goreleaser/goreleaser-cross
       shell: bash
       run: |
-        echo $DOCKER_TOKEN | docker login --username $DOCKER_USERNAME --password-stdin
+        CONTAINER_ID="$(
+          docker run --detach \
+            --volume "$PWD:$PWD" \
+            --entrypoint tail \
+            ghcr.io/goreleaser/goreleaser-cross:latest \
+              -f /dev/null
+        )"
+        docker exec --tty "$CONTAINER_ID" dpkg --add-architecture i386
+        docker exec --tty "$CONTAINER_ID" apt-get update
+        docker exec --tty "$CONTAINER_ID" apt-get install --no-install-recommends -y -q crossbuild-essential-i386
+        docker exec --tty "$CONTAINER_ID" git config --global --add safe.directory '*'
+        echo "CONTAINER_ID=$CONTAINER_ID" >> "$GITHUB_ENV"
+
     - name: Run Goreleaser
-      uses: goreleaser/goreleaser-action@v5
-      with:
-        version: latest
-        args: release ${{ inputs.dry-run == 'true' && '--skip=publish' || '' }} --config .goreleaser.yaml
+      shell: bash
+      run: docker exec
+        --env GITHUB_TOKEN
+        --env HOMEBREW_DEPLOY_KEY
+        --workdir "$PWD"
+        --tty
+        "$CONTAINER_ID"
+        goreleaser release ${{ inputs.dry-run == 'true' && '--skip=publish' || '' }} --config .goreleaser.yaml
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
         HOMEBREW_DEPLOY_KEY: ${{ inputs.homebrew-gh-secret }}
+    - name: Upload assets
+      uses: actions/upload-artifact@v4
+      with:
+        name: ldcli
+        path: dist/*
     - name: Hash build artifacts for provenance
       id: hash
       shell: bash

.gitignore

@@ -2,3 +2,4 @@
 dist/
 *.log
 node_modules/
+devserver.db

.goreleaser.yaml

@@ -1,3 +1,12 @@
+version: 2
+
+project_name: ldcli
+
+env:
+  - GO111MODULE=on # Ensure we aren't using anything in GOPATH when building
+  - CGO_ENABLED=1 # Needed for SQLite support
+  - DOCKER_CLI_EXPERIMENTAL=enabled # This is on by default in docker versions >= 20.10
+
 builds:
   - id: ldcli
     binary: ldcli
@@ -6,43 +15,68 @@ builds:
       - linux
       - windows
     goarch:
-      - 386
+      - "386"
       - amd64
       - arm64
+    ldflags:
+      - -s # Omit all symbol information to minimize binary size
+      - -w # Omit DWARF to minimize binary size
+      - -X 'main.version={{.Version}}'
+    ignore:
+      - goos: darwin
+        goarch: "386"
     env:
-      - CGO_ENABLED=0
+      # The below environment variables set up the c compiler toolchain for CGO.
+      # Templates are used to vary the toolchain based on OS & platform.
+      - TOOLCHAIN_BASE=
+        {{- if eq .Os "darwin" -}}
+          o
+          {{- if eq .Arch "arm64" -}}a{{- end -}}
+          64-clang
+        {{- else -}}
+          {{- if eq .Os "windows" -}}/llvm-mingw/bin/{{- end -}}
+          {{- if eq .Arch "386" -}}i686{{- end -}}
+          {{- if eq .Arch "arm64" -}}aarch64{{- end -}}
+          {{- if eq .Arch "amd64" -}}x86_64{{- end -}}
+          -
+          {{- if eq .Os "windows" -}}w64-mingw32{{- end -}}
+          {{- if eq .Os "linux" -}}linux-gnu{{- end -}}
+        {{- end -}}
+      - CC={{ .Env.TOOLCHAIN_BASE }}{{ if ne .Os "darwin" }}-gcc{{ end }}
+      - CXX={{ .Env.TOOLCHAIN_BASE }}{{ if eq .Os "darwin" }}++{{ else }}-g++{{ end }}
+
 dockers:
   # AMD64
   - image_templates:
-    - "launchdarkly/ldcli:{{ .Version }}-amd64"
-    - "launchdarkly/ldcli:v{{ .Major }}-amd64"
-    - "launchdarkly/ldcli:latest-amd64"
+      - "launchdarkly/ldcli:{{ .Version }}-amd64"
+      - "launchdarkly/ldcli:v{{ .Major }}-amd64"
+      - "launchdarkly/ldcli:latest-amd64"
     goos: linux
     goarch: amd64
     dockerfile: Dockerfile.goreleaser
     skip_push: false
     build_flag_templates:
-    - "--pull"
-    - "--platform=linux/amd64"
+      - "--pull"
+      - "--platform=linux/amd64"
 
   # ARM64v8
   - image_templates:
-    - "launchdarkly/ldcli:{{ .Version }}-arm64v8"
-    - "launchdarkly/ldcli:v{{ .Major }}-arm64v8"
-    - "launchdarkly/ldcli:latest-arm64v8"
+      - "launchdarkly/ldcli:{{ .Version }}-arm64v8"
+      - "launchdarkly/ldcli:v{{ .Major }}-arm64v8"
+      - "launchdarkly/ldcli:latest-arm64v8"
     goos: linux
     goarch: arm64
     dockerfile: Dockerfile.goreleaser
     skip_push: false
     build_flag_templates:
-    - "--pull"
-    - "--platform=linux/arm64/v8"
+      - "--pull"
+      - "--platform=linux/arm64/v8"
 docker_manifests:
   - name_template: "launchdarkly/ldcli:{{ .Version}}"
     skip_push: false
     image_templates:
-     - "launchdarkly/ldcli:{{ .Version }}-amd64"
-     - "launchdarkly/ldcli:{{ .Version }}-arm64v8"
+      - "launchdarkly/ldcli:{{ .Version }}-amd64"
+      - "launchdarkly/ldcli:{{ .Version }}-arm64v8"
 
   - name_template: "launchdarkly/ldcli:v{{ .Major }}"
     skip_push: false
@@ -56,8 +90,7 @@ docker_manifests:
       - "launchdarkly/ldcli:latest-amd64"
       - "launchdarkly/ldcli:latest-arm64v8"
 brews:
-  -
-    name: ldcli
+  - name: ldcli
     description: "The official command line interface for managing LaunchDarkly feature flags."
     homepage: "https://launchdarkly.com"
     repository:

.pre-commit-config.yaml

@@ -16,7 +16,12 @@ repos:
         exclude: '^vendor/|^.circleci/image/tools'
         name: run-go-tests
       - id: discarded-stacktrace
-        exclude: '(^vendor/)'
+        exclude: '(^vendor/|.*gen\.go)'
       - id: go-mod-tidy
       - id: go-mod-verify
       - id: go-mod-vendor-no-change
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+        exclude: '^vendor'

Dockerfile.goreleaser

@@ -1,8 +1,5 @@
 FROM alpine:3.19.1
 
-RUN apk update
-RUN apk add --no-cache git
-
 COPY ldcli /ldcli
 
 LABEL homepage="https://www.launchdarkly.com"

cmd/cliflags/flags.go

@@ -1,36 +1,44 @@
 package cliflags
 
 const (
-	BaseURIDefault = "https://app.launchdarkly.com"
+	BaseURIDefault      = "https://app.launchdarkly.com"
+	DevStreamURIDefault = "https://stream.launchdarkly.com"
+	PortDefault         = "8765"
 
-	AccessTokenFlag = "access-token"
-	AnalyticsOptOut = "analytics-opt-out"
-	BaseURIFlag     = "base-uri"
-	DataFlag        = "data"
-	EmailsFlag      = "emails"
-	EnvironmentFlag = "environment"
-	FlagFlag        = "flag"
-	OutputFlag      = "output"
-	ProjectFlag     = "project"
-	RoleFlag        = "role"
+	AccessTokenFlag  = "access-token"
+	AnalyticsOptOut  = "analytics-opt-out"
+	BaseURIFlag      = "base-uri"
+	DataFlag         = "data"
+	DevStreamURIFlag = "dev-stream-uri"
+	EmailsFlag       = "emails"
+	EnvironmentFlag  = "environment"
+	FlagFlag         = "flag"
+	OutputFlag       = "output"
+	PortFlag         = "port"
+	ProjectFlag      = "project"
+	RoleFlag         = "role"
 
 	AccessTokenFlagDescription = "LaunchDarkly access token with write-level access"
 	AnalyticsOptOutDescription = "Opt out of analytics tracking"
 	BaseURIFlagDescription     = "LaunchDarkly base URI"
+	DevStreamURIDescription    = "Streaming service endpoint that the dev server uses to obtain authoritative flag data. This may be a LaunchDarkly or Relay Proxy endpoint"
 	EnvironmentFlagDescription = "Default environment key"
 	FlagFlagDescription        = "Default feature flag key"
 	OutputFlagDescription      = "Command response output format in either JSON or plain text"
+	PortFlagDescription        = "Port for the dev server to run on"
 	ProjectFlagDescription     = "Default project key"
 )
 
 func AllFlagsHelp() map[string]string {
 	return map[string]string{
-		AccessTokenFlag: AccessTokenFlagDescription,
-		AnalyticsOptOut: AnalyticsOptOutDescription,
-		BaseURIFlag:     BaseURIFlagDescription,
-		EnvironmentFlag: EnvironmentFlagDescription,
-		FlagFlag:        FlagFlagDescription,
-		OutputFlag:      OutputFlagDescription,
-		ProjectFlag:     ProjectFlagDescription,
+		AccessTokenFlag:  AccessTokenFlagDescription,
+		AnalyticsOptOut:  AnalyticsOptOutDescription,
+		BaseURIFlag:      BaseURIFlagDescription,
+		DevStreamURIFlag: DevStreamURIDescription,
+		EnvironmentFlag:  EnvironmentFlagDescription,
+		FlagFlag:         FlagFlagDescription,
+		OutputFlag:       OutputFlagDescription,
+		PortFlag:         PortFlagDescription,
+		ProjectFlag:      ProjectFlagDescription,
 	}
 }

cmd/config/testdata/help.golden

@@ -4,9 +4,11 @@ Supported settings:
 - `access-token`: LaunchDarkly access token with write-level access
 - `analytics-opt-out`: Opt out of analytics tracking
 - `base-uri`: LaunchDarkly base URI
+- `dev-stream-uri`: Streaming service endpoint that the dev server uses to obtain authoritative flag data. This may be a LaunchDarkly or Relay Proxy endpoint
 - `environment`: Default environment key
 - `flag`: Default feature flag key
 - `output`: Command response output format in either JSON or plain text
+- `port`: Port for the dev server to run on
 - `project`: Default project key
 
 Usage:

cmd/dev_server/dev_server.go

@@ -0,0 +1,60 @@
+package dev_server
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"github.com/launchdarkly/ldcli/cmd/cliflags"
+	resourcecmd "github.com/launchdarkly/ldcli/cmd/resources"
+	"github.com/launchdarkly/ldcli/internal/dev_server"
+	"github.com/launchdarkly/ldcli/internal/resources"
+)
+
+func NewDevServerCmd(client resources.Client, ldClient dev_server.Client) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "dev-server",
+		Short: "Development server",
+		Long:  "Start and use a local development server for overriding flag values.",
+	}
+
+	cmd.PersistentFlags().String(
+		cliflags.DevStreamURIFlag,
+		cliflags.DevStreamURIDefault,
+		cliflags.DevStreamURIDescription,
+	)
+	_ = viper.BindPFlag(cliflags.DevStreamURIFlag, cmd.PersistentFlags().Lookup(cliflags.DevStreamURIFlag))
+
+	cmd.PersistentFlags().String(
+		cliflags.PortFlag,
+		cliflags.PortDefault,
+		cliflags.PortFlagDescription,
+	)
+
+	_ = viper.BindPFlag(cliflags.PortFlag, cmd.PersistentFlags().Lookup(cliflags.PortFlag))
+
+	// Add subcommands here
+	cmd.AddGroup(&cobra.Group{ID: "projects", Title: "Project commands:"})
+	cmd.AddCommand(NewListProjectsCmd(client))
+	cmd.AddCommand(NewGetProjectCmd(client))
+	cmd.AddCommand(NewSyncProjectCmd(client))
+	cmd.AddCommand(NewRemoveProjectCmd(client))
+	cmd.AddCommand(NewAddProjectCmd(client))
+
+	cmd.AddGroup(&cobra.Group{ID: "overrides", Title: "Override commands:"})
+	cmd.AddCommand(NewAddOverrideCmd(client))
+	cmd.AddCommand(NewRemoveOverrideCmd(client))
+	cmd.AddGroup(&cobra.Group{ID: "server", Title: "Server commands:"})
+
+	cmd.AddCommand(NewStartServerCmd(ldClient))
+	cmd.AddCommand(NewUICmd())
+
+	cmd.SetUsageTemplate(resourcecmd.SubcommandUsageTemplate())
+
+	return cmd
+}
+
+func getDevServerUrl() string {
+	return fmt.Sprintf("http://localhost:%s", viper.GetString(cliflags.PortFlag))
+}