feat: support .defangrc (#1402)

* feat: support .defangrc

* Update vendorHash in cli.nix

Updated vendorHash for defang-cli in cli.nix.

Author: lionello

Makefile

@@ -17,10 +17,10 @@ setup:
 	go -C src mod tidy
 
 src/README.md: README.md
-	@awk '/^## Develop Once\. Deploy Anywhere\./{p=1} (/^## /||/^### /){if(p&&!/^## Develop Once\. Deploy Anywhere\./){exit}} p' README.md > src/README.md; \
-	awk '/^## Defang CLI/{p=1} (/^## /||/^### /){if(p&&!/^## Defang CLI/){exit}} p' README.md >> src/README.md; \
-	awk '/^## Getting started/{p=1} (/^## /||/^### /){if(p&&!/^## Getting started/){exit}} p' README.md >> src/README.md; \
-	awk '/^## Support/{p=1} (/^## /||/^### /){if(p&&!/^## Support/){exit}} p' README.md >> src/README.md; \
-	awk '/^## Environment Variables/{p=1} (/^## /||/^### /){if(p&&!/^## Environment Variables/){exit}} p' README.md >> src/README.md; \
+	@awk '/^## Develop Once, Deploy Anywhere\./{p=1} (/^## /||/^### /){if(p&&!/^## Develop Once, Deploy Anywhere\./){exit}} p' $< > $@
+	@awk '/^## Defang CLI/{p=1} (/^## /||/^### /){if(p&&!/^## Defang CLI/){exit}} p' $< >> $@
+	@awk '/^## Getting started/{p=1} (/^## /||/^### /){if(p&&!/^## Getting started/){exit}} p' $< >> $@
+	@awk '/^## Support/{p=1} (/^## /||/^### /){if(p&&!/^## Support/){exit}} p' $< >> $@
+	@awk '/^## Environment Variables/{p=1} (/^## /||/^### /){if(p&&!/^## Environment Variables/){exit}} p' $< >> $@
 	@echo 'src/README.md was updated because root README.md changed. Please add src/README.md to your commit.';
 	@false

README.md

@@ -4,13 +4,16 @@
 
 ### ![Defang](https://raw.githubusercontent.com/DefangLabs/defang-assets/main/Logos/Element_Wordmark_Slogan/JPG/Dark_Colour_Glow.jpg)
 
-## Develop Once. Deploy Anywhere.
+## Develop Once, Deploy Anywhere.
+
 Take your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.
 
 ## Defang CLI
+
 The Defang Command-Line Interface [(CLI)](https://docs.defang.io/docs/getting-started) is designed for developers who prefer to manage their workflows directly from the terminal. It offers full access to Defang’s capabilities, allowing you to build, test, and deploy applications efficiently to the cloud.
 
 ## Defang MCP Server
+
 The Defang Model Context Protocol [(MCP)](https://docs.defang.io/docs/concepts/mcp) Server is tailored for developers who work primarily within integrated development environments (IDEs). It enables seamless cloud deployment from supported editors such as Cursor, Windsurf, VS Code, VS Code Insiders and Claude delivering a fully integrated experience without leaving your development environment.
 
 ## This repo includes:
@@ -20,7 +23,6 @@ The Defang Model Context Protocol [(MCP)](https://docs.defang.io/docs/concepts/m
 - [Samples](https://github.com/DefangLabs/samples) in Golang, Python, and Node.js that show how to accomplish various tasks and deploy them to the DOP using a Docker Compose file using the Defang CLI.
 - Samples that show how to deploy an app using the [Defang Pulumi Provider](https://github.com/DefangLabs/pulumi-defang).
 
-
 ## Getting started
 
 - Read our [Getting Started](https://docs.defang.io/docs/getting-started) page
@@ -33,22 +35,26 @@ The Defang Model Context Protocol [(MCP)](https://docs.defang.io/docs/concepts/m
 
 Install the Defang CLI from one of the following sources:
 
-* Using the [Homebrew](https://brew.sh) package manager [DefangLabs/defang tap](https://github.com/DefangLabs/homebrew-defang):
+- Using the [Homebrew](https://brew.sh) package manager [DefangLabs/defang tap](https://github.com/DefangLabs/homebrew-defang):
+
   ```
   brew install DefangLabs/defang/defang
   ```
 
-* Using a shell script:
+- Using a shell script:
+
   ```
   eval "$(curl -fsSL s.defang.io/install)"
   ```
 
-* Using [Go](https://go.dev):
+- Using [Go](https://go.dev):
+
   ```
   go install github.com/DefangLabs/defang/src/cmd/cli@latest
   ```
 
-* Using the [Nix package manager](https://nixos.org):
+- Using the [Nix package manager](https://nixos.org):
+
   - with Nix-Env:
     ```
     nix-env -if https://github.com/DefangLabs/defang/archive/main.tar.gz
@@ -58,23 +64,26 @@ Install the Defang CLI from one of the following sources:
     nix profile install github:DefangLabs/defang#defang-bin --refresh
     ```
 
-* Using [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/):
+- Using [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/):
+
   ```
   winget install defang
   ```
 
-* Using a PowerShell script:
+- Using a PowerShell script:
+
   ```
   iwr https://s.defang.io/defang_win_amd64.zip -OutFile defang.zip
   Expand-Archive defang.zip . -Force
   ```
 
-* Using the [official image from Docker Hub](https://hub.docker.com/r/defangio/defang-cli):
+- Using the [official image from Docker Hub](https://hub.docker.com/r/defangio/defang-cli):
+
   ```
   docker run -it defangio/defang-cli help
   ```
-  
-* or download the [latest binary](https://github.com/DefangLabs/defang/releases/latest/) of the Defang CLI.
+
+- or download the [latest binary](https://github.com/DefangLabs/defang/releases/latest/) of the Defang CLI.
 
 ## Support
 
@@ -145,13 +154,16 @@ The Defang CLI recognizes the following environment variables:
 - `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local`
 - `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state`
 
+Environment variables will be loaded from a `.defangrc` file in the current directory, if it exists. This file follows
+the same format as a `.env` file: `KEY=VALUE` pairs on each line, lines starting with `#` are treated as comments and ignored.
+
 ## Development
+
 At Defang we use the [Nix package manager](https://nixos.org) for our dev environment, in conjunction with [DirEnv](https://direnv.net).
 
 To get started quickly, install Nix and DirEnv, then create a `.envrc` file to automatically load the Defang developer environment:
+
 ```sh
 echo use flake >> .envrc
 direnv allow
 ```
-
-

pkgs/defang/cli.nix

@@ -7,7 +7,7 @@ buildGoModule {
   pname = "defang-cli";
   version = "git";
   src = ../../src;
-  vendorHash = "sha256-SpV97d+MskTCcdsBYJe/afzxzCo5TUtAef9m+lZT6/o="; # TODO: use fetchFromGitHub
+  vendorHash = "sha256-0M0jtBaPE1jSx4nrOR4XMw1Im1tMYTKYCkcKiZ1bj8M="; # TODO: use fetchFromGitHub
 
   subPackages = [ "cmd/cli" ];
 

src/README.md

@@ -1,7 +1,9 @@
-## Develop Once. Deploy Anywhere.
+## Develop Once, Deploy Anywhere.
+
 Take your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.
 
 ## Defang CLI
+
 The Defang Command-Line Interface [(CLI)](https://docs.defang.io/docs/getting-started) is designed for developers who prefer to manage their workflows directly from the terminal. It offers full access to Defang’s capabilities, allowing you to build, test, and deploy applications efficiently to the cloud.
 
 ## Getting started
@@ -47,3 +49,6 @@ The Defang CLI recognizes the following environment variables:
 - `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local`
 - `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state`
 
+Environment variables will be loaded from a `.defangrc` file in the current directory, if it exists. This file follows
+the same format as a `.env` file: `KEY=VALUE` pairs on each line, lines starting with `#` are treated as comments and ignored.
+

src/cmd/cli/autoload/load.go

@@ -0,0 +1,7 @@
+package rc
+
+import "github.com/joho/godotenv"
+
+func init() {
+	godotenv.Load(".defangrc")
+}

src/cmd/cli/command/commands.go

@@ -13,6 +13,7 @@ import (
 	"time"
 
 	"github.com/AlecAivazis/survey/v2"
+	_ "github.com/DefangLabs/defang/src/cmd/cli/autoload"
 	"github.com/DefangLabs/defang/src/pkg"
 	"github.com/DefangLabs/defang/src/pkg/cli"
 	cliClient "github.com/DefangLabs/defang/src/pkg/cli/client"

src/go.mod

@@ -41,6 +41,7 @@ require (
 	github.com/gorilla/websocket v1.5.0
 	github.com/hashicorp/go-retryablehttp v0.7.7
 	github.com/hexops/gotextdiff v1.0.3
+	github.com/joho/godotenv v1.5.1
 	github.com/mark3labs/mcp-go v0.29.0
 	github.com/miekg/dns v1.1.59
 	github.com/moby/patternmatcher v0.6.0

src/go.sum

@@ -217,6 +217,8 @@ github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9Y
 github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs=
 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8=
 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=