defang
Deploy any Docker Compose app to your own cloud account on AWS or GCP in minutes. The `/defang:deploy` skill guides you through the full wor
Open source Repository Open in the app JSON README (API)
About
Deploy any Docker Compose app to your own cloud account on AWS or GCP in minutes. The `/defang:deploy` skill guides you through the full workflow. Your code and secrets never leave your infrastructure.
Details
- Kind
- Plugins
- Topic
- Cloud & DevOps
- Publisher
- defanglabs
- Origin
- marketplace
- Category
- ferramentas
- Stars
- 165
- Forks
- 24
- Open pull requests
- 21
- Last push
- 2026-09-10T00:28:05Z
- Repository state
- ativo
- Language
- Go
- License
- MIT
- Added
- 2026-08-30 01:48:58
- Updated
- 2026-08-30 01:48:58
- Origin id
defanglabs/defang/defang
README
[](https://github.com/DefangLabs/defang/actions/workflows/go.yml)
[](https://s.defang.io/discord)
[](https://mcptoplist.com/server/mcp.so%2Fdefang%2FDefangLabs)
### 
## Develop Once, Deploy Anywhere.
Take your app from Compose to a secure and scalable deployment on your favorite cloud in minutes.
### How It Works
```mermaid
flowchart LR
subgraph local["Your Machine or CI/CD"]
compose["compose.yaml"] --> cli["Defang CLI"]
end
subgraph defang["Defang Backend"]
fabric["Fabric API (gRPC)"]
end
subgraph cloud["Your Cloud Account"]
secrets["Config & Secrets"]
cd["Defang CD Task"]
logs["Logs"]
runtime["Load Balancer, Containers, DB, Cache, LLM, DNS, Roles"]
end
%% control plane
cli <-.-> fabric
%% deploy
cli --> secrets
cli --> cd
cd --> runtime
%% observability
cli -.-> logs
```
1. **You write** a standard Docker **Compose** file
2. **Defang CLI** validates your Compose project and uploads the project to storage in your AWS/GCP account
3. **CD runs in your cloud** — a deployment task spins up in your AWS/GCP account
4. **Infrastructure is created** — containers, DNS, load balancing, and roles are provisioned
5. **Monitor** the deployment and tail or query runtime logs with the Defang CLI
Your code and secrets never leave your cloud account. Defang orchestrates the deployment, but everything runs in your infrastructure.
## 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.
### Deploying with Defang
If you already have a Docker Compose file, create a new [stack](https://docs.defang.io/docs/concepts/stacks) and then deploy it. For example:
```shell
$ defang stack new
? Which cloud provider do you want to deploy to? AWS
? Which AWS region do you want to deploy to? us-west-2
? Which deployment mode do you want to use? AFFORDABLE
? What do you want to call this stack? awsuswest2
* Created new stack configuration file: `.defang/awsuswest2`. Check this file into version control. You can now deploy this stack using `defang up --stack=awsuswest2`
$ defang up --stack=awsuswest2
```
## Defang MCP Server
[](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22defang%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22defang%40latest%22%2C%22mcp%22%2C%22serve%22%2C%22--client%3Dvscode%22%5D%7D)
[](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install?%7B%22name%22%3A%22defang%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22defang%40latest%22%2C%22mcp%22%2C%22serve%22%2C%22--client%3Dvscode-insiders%22%5D%7D)
[](https://cursor.com/en-US/install-mcp?name=defang&config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoibnB4IC15IGRlZmFuZyBtY3Agc2VydmUgLS1jbGllbnQgY3Vyc29yIn0%3D)
[](https://kiro.dev/launch/mcp/add?name=defang&config=%7B%22command%22%3A%20%22npx%22%2C%20%22args%22%3A%20%5B%22-y%22%2C%20%22defang%40latest%22%2C%20%22mcp%22%2C%20%22serve%22%2C%20%22--client%3Dkiro%22%5D%2C%20%22disabled%22%3A%20false%2C%20%22autoApprove%22%3A%20%5B%5D%7D)
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.
## Claude Code Plugin
Install the Defang plugin for [Claude Code](https://claude.ai/code) to deploy directly from any Claude Code session — no CLI required upfront:
```shell
/plugin marketplace add DefangLabs/defang
/plugin install defang@defang-skills
```
After installing, use `/defang:deploy` to guide you through deploying your project. The Defang MCP server activates automatically once the Defang CLI is installed.
## This repo includes:
- Public releases of the Defang CLI; [click here](https://github.com/DefangLabs/defang/releases/latest/) for the latest version
- Built-in support for MCP Server — the Defang MCP Server makes cloud deployment as easy as a single prompt. [Learn more](https://docs.defang.io/docs/concepts/mcp)
- 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
- Follow the installation instructions from the [Installing](https://docs.defang.io/docs/getting-started/installing) page
- Take a look at our [Samples](https://github.com/DefangLabs/samples) in Golang, Python, and Node.js that show how to accomplish various tasks and deploy them
- Try the AI integration by running `defang generate`
- Start your new service with `defang compose up`
## Installing
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):
```
brew install DefangLabs/defang/defang
```
- Using a shell script:
```
eval "$(curl -fsSL s.defang.io/install)"
```
- Using [Go](https://go.dev):
```
go install github.com/DefangLabs/defang/src/cmd/cli@latest
```
- Using the [Nix package manager](https://nixos.org):
- with Nix-Env:
```
nix-env -if https://github.com/DefangLabs/defang/archive/main.tar.gz
```
- or with Flakes:
```
nix profile install github:DefangLabs/defang#defang-cli --refresh
```
Released tags are available from our [Cachix](https://cachix.org) binary cache, so
you can download the CLI instead of compiling it. If you have Cachix installed, run
`cachix use defanglabs`; otherwise add these lines to `/etc/nix/nix.conf` (or
`~/.config/nix/nix.conf` if you are a [trusted user](https://nix.dev/manual/nix/stable/command-ref/conf-file#conf-trusted-users)):
```nix
extra-substituters = https://defanglabs.cachix.org
extra-trusted-public-keys = defanglabs.cachix.org-1:mTXLTfYprWDrIK50Kz34fhOTreeKlQRZFQcKL7HtHx0=
```
Then install a tagged version, e.g. `nix profile install github:DefangLabs/defang/v3.14.1#defang-cli`.
The cache holds `x86_64-linux` and `aarch64-darwin` builds. Other platforms, and
builds from `main`, compile from source as before.
- Using [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/):
```
winget install defang
```
- 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):
```
docker run -it defangio/defang-cli help
```
- Using [NPX](https://docs.npmjs.com/cli/v9/commands/npx):
```
npx defang@latest help
```
- or download the [latest binary](https://github.com/DefangLabs/defang/releases/latest/) of the Defang CLI.
## Support
- File any issues [here](https://github.com/DefangLabs/defang/issues)
## Command completion
The Defang CLI supports command completion for Bash, Zsh, Fish, and Powershell. To get the shell script for command completion, run the following command:
```
defang completion [bash|zsh|fish|powershell]
```
If you're using Bash, you can add the following to your `~/.bashrc` file:
```
source <(defang completion bash)
```
If you're using Zsh, you can add the following to your `~/.zshrc` file:
```
source <(defang completion zsh)
```
or pipe the output to a file called `_defang` in the directory with the completions.
If you're using Fish, you can add the following to your `~/.config/fish/config.fish` file:
```
defang completion fish | source
```
If you're using Powershell, you can add the following to your `$HOME\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` file:
```
Invoke-Expression -Command (defang completion powershell | Out-String)
```
## Environment Variables
The Defang CLI recognizes the following environment variables:
- `COMPOSE_DISABLE_ENV_FILE` - Whether to disable loading environment variables from a `.env` file in the current directory; defaults to `false`
- `COMPOSE_ENV_FILES` - A comma-separated list of environment file(s) to use for interpolation instead of `.env`; overridden by the `--env-file` flag
- `COMPOSE_FILE` - The Compose file(s) to use; defaults to `compose.yaml`, `compose.yml`, `docker-compose.yaml`, or `docker-compose.yml` in the current directory
- `COMPOSE_PATH_SEPARATOR` - The path separator to use for `COMPOSE_FILE`; defaults to `:` on Unix/MacOS and `;` on Windows
- `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the `name` in the Compose file
- `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login`
- `DEFANG_ALLOW_UPGRADE` - If set to `true`, allows upgrading the CD image and Pulumi version to the latest available; defaults to `false`, ie. previously deployed versions will be used to avoid unexpected upgrades
- `DEFANG_AWS_APN_ID` - The AWS APN ID to use for attribution, eg. use `pc:123456789abcdefgh` for AWS Marketplace products
- `DEFANG_BUILD_CONTEXT_LIMIT` - The maximum size of the build context when building container images; defaults to `100MiB`
- `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…`
- `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta`
- `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging
- `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false`
- `DEFANG_EDITOR` - The editor to launch after new project generation; defaults to `code` (VS Code)
- `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev`
- `DEFANG_JSON` - If set to `true`, outputs JSON instead of human-readable output; defaults to `false`
- `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false`
- `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false`
- `DEFANG_ISSUER` - The OAuth2 issuer to use for authentication; defaults to `https://auth.defang.io`
- `DEFANG_MODEL_ID` - The model ID of the LLM to use for the generate/debug AI integration (Pro users only)
- `DEFANG_NO_CACHE` - If set to `true`, disables pull-through caching of container images; defaults to `false`
- `DEFANG_PREFIX` - The prefix to use for all BYOC resources; defaults to `Defang`
- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, `azure`, `digitalocean`, `gcp`, or `defang`
- `DEFANG_PULUMI_BACKEND` - The Pulumi backend URL or `"pulumi-cloud"`; defaults to a self-hosted backend
- `DEFANG_PULUMI_DEBUG` - If set to `true`, enables debug logging for Pulumi operations; defaults to `false`
- `DEFANG_PULUMI_DIFF` - If set to `true`, shows the Pulumi diff during deployments; defaults to `false`
- `DEFANG_PULUMI_DIR` - Run Pulumi from this folder, instead of spawning a cloud task; requires `--debug` (BYOC only)
- `DEFANG_PULUMI_VERSION` - Override the version of the Pulumi image to use (`aws` provider only)
- `DEFANG_RECIPE` - The deployment mode / recipe to use; defaults to `AFFORDABLE`
- `DEFANG_STACK` - The name of the stack to use
- `DEFANG_SUFFIX` - The suffix to use for all BYOC resources; defaults to the stack name, or `beta` if unset.
- `DEFANG_WORKSPACE` - The workspace (name or ID) to use; preferred way to select which workspace the CLI uses
- `GCP_PROJECT_ID` - The Google Cloud project ID for the `gcp` provider; must be a real shell environment variable (e.g. `export GCP_PROJECT_ID=my-project-id`), not set via `defang config set`. Also recognized: `GOOGLE_PROJECT`, `GOOGLE_CLOUD_PROJECT`, `GCLOUD_PROJECT`, `CLOUDSDK_CORE_PROJECT`
- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal
- `PULUMI_ACCESS_TOKEN` - The Pulumi access token to use for authentication to Pulumi Cloud; see `DEFANG_PULUMI_BACKEND`
- `PULUMI_CONFIG_PASSPHRASE` - Passphrase used to generate a unique key for your stack, and configuration and encrypted state values
- `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 `.defang` 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.
### Compose interpolation
After selecting a stack, the CLI makes the resolved `DEFANG_PROVIDER` and `DEFANG_STACK` values available for Compose
interpolation. They are not injected into services automatically; reference them explicitly where needed:
```yaml
services:
app:
environment:
PUBLISH_PROVIDER: "${DEFANG_PROVIDER}"
PUBLISH_STACK: "${DEFANG_STACK}"
```
The resolved values take precedence over values with the same names in Compose env files. Fields that Compose must decode
before stack selection should provide a default, such as `${DEFANG_PROVIDER:-auto}`.
## 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
```
### Adding cloud support
At a high-level, support for a specific cloud lives in three repositories:
- In [this CLI repository](https://github.com/DefangLabs/defang)
- an implementation of the [client.Provider](src/pkg/cli/client/byoc) interface under the [`byoc` package](src/pkg/cli/client/byoc)
- low-level cloud helpers ("driver") under the [`clouds` package](src/pkg/clouds)
- authenticate with the cloud
- start a CD container (task/job)
- monitor the CD container's status and logs
- stream/query logs from deployed services
- set/list config (secrets/parameters)
- In the [Defang Pulumi Provider repository](https://github.com/DefangLabs/pulumi-defang)
- Pulumi **component** resources under the `provider` folder
- `Project` component
- `Service` component
- `Postgres` component
- `Redis` component
- a Pulumi **custom** resource for `Build`
- an implementation of the `ConfigProvider` interface to read config (secrets/parameters) at deploy time
- In the [Defang Docs repository](https://github.com/DefangLabs/defang-docs)
- under the [`providers` section](https://docs.defang.io/docs/providers), documentation for how to set up credentials and permissions for the cloud, and any cloud-specific features