|
1 |
| -[](https://github.com/defang-io/defang/actions/workflows/go.yml) |
| 1 | +[](https://github.com/DefangLabs/defang/actions/workflows/go.yml) |
2 | 2 |
|
3 | 3 | # Defang
|
| 4 | + |
4 | 5 | Defang is a radically simpler way for developers to create, deploy, and manage cloud applications.
|
5 | 6 |
|
6 | 7 | This repo includes:
|
7 |
| -* Public releases of the Defang CLI; [click here](https://github.com/defang-io/defang/releases/latest/) for the latest version |
| 8 | +* Public releases of the Defang CLI; [click here](https://github.com/DefangLabs/defang/releases/latest/) for the latest version |
8 | 9 | * 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.
|
9 |
| -* Samples that show how to deploy an app using the [Defang Pulumi Provider](https://github.com/defang-io/pulumi-defang). |
| 10 | +* Samples that show how to deploy an app using the [Defang Pulumi Provider](https://github.com/DefangLabs/pulumi-defang). |
10 | 11 |
|
11 | 12 | ## Getting started
|
12 | 13 | * Read our [Getting Started](https://docs.defang.io/docs/getting-started) page
|
13 | 14 | * Follow the installation instructions from the [Installing](https://docs.defang.io/docs/getting-started/installing) page
|
14 |
| -* Take a look at our [Samples folder](https://github.com/defang-io/defang/tree/main/samples) for example projects in various programming languages. |
| 15 | +* Take a look at our [Samples folder](https://github.com/DefangLabs/defang/tree/main/samples) for example projects in various programming languages. |
15 | 16 | * Try the AI integration by running `defang generate`
|
16 | 17 | * Start your new service with `defang compose up`
|
17 | 18 |
|
18 | 19 | ## Installing
|
| 20 | + |
19 | 21 | Install the Defang CLI from one of the following sources:
|
20 |
| -* Using the [Homebrew](https://brew.sh) package manager [defang-io/defang tap](https://github.com/defang-io/homebrew-defang): |
| 22 | +* Using the [Homebrew](https://brew.sh) package manager [DefangLabs/defang tap](https://github.com/DefangLabs/homebrew-defang): |
21 | 23 | ```
|
22 |
| - brew install defang-io/defang/defang |
| 24 | + brew install DefangLabs/defang/defang |
23 | 25 | ```
|
24 |
| -* Using a shell script: |
| 26 | +- Using a shell script: |
25 | 27 | ```
|
26 | 28 | . <(curl -Ls https://s.defang.io/install)
|
27 | 29 | ```
|
28 |
| -* Using [Go](https://go.dev): |
| 30 | +- Using [Go](https://go.dev): |
29 | 31 | ```
|
30 |
| - go install github.com/defang-io/defang/src/cmd/cli@latest |
| 32 | + go install github.com/DefangLabs/defang/src/cmd/cli@latest |
31 | 33 | ```
|
32 |
| -* Using the [Nix package manager](https://nixos.org): |
33 |
| - * with Nix-Env: |
| 34 | +- Using the [Nix package manager](https://nixos.org): |
| 35 | + - with Nix-Env: |
34 | 36 | ```
|
35 |
| - nix-env -if https://github.com/defang-io/defang/archive/main.tar.gz |
| 37 | + nix-env -if https://github.com/DefangLabs/defang/archive/main.tar.gz |
36 | 38 | ```
|
37 |
| - * or with Flakes: |
| 39 | + - or with Flakes: |
38 | 40 | ```
|
39 |
| - nix profile install github:defang-io/defang#defang-bin --refresh |
| 41 | + nix profile install github:DefangLabs/defang#defang-bin --refresh |
40 | 42 | ```
|
41 |
| -* Download the [latest binary](https://github.com/defang-io/defang/releases/latest/) of the Defang CLI. For this beta, MacOS users will have to explicitly allow running of downloaded programs in the OS security settings. |
| 43 | +* Download the [latest binary](https://github.com/DefangLabs/defang/releases/latest/) of the Defang CLI. For this beta, MacOS users will have to explicitly allow running of downloaded programs in the OS security settings. |
42 | 44 |
|
43 | 45 | ## Support
|
44 |
| -* File any issues [right here on GitHub](https://github.com/defang-io/defang/issues) |
| 46 | +* File any issues [right here on GitHub](https://github.com/DefangLabs/defang/issues) |
45 | 47 |
|
46 | 48 | ## Command completion
|
| 49 | +
|
47 | 50 | The Defang CLI supports command completion for Bash, Zsh, Fish, and Powershell. To get the shell script for command completion, run the following command:
|
| 51 | +
|
48 | 52 | ```
|
49 | 53 | defang completion [bash|zsh|fish|powershell]
|
50 | 54 | ```
|
51 | 55 |
|
52 | 56 | If you're using Bash, you can add the following to your `~/.bashrc` file:
|
| 57 | +
|
53 | 58 | ```
|
54 | 59 | source <(defang completion bash)
|
55 | 60 | ```
|
56 | 61 |
|
57 | 62 | If you're using Zsh, you can add the following to your `~/.zshrc` file:
|
| 63 | +
|
58 | 64 | ```
|
59 | 65 | source <(defang completion zsh)
|
60 | 66 | ```
|
| 67 | +
|
61 | 68 | or pipe the output to a file called `_defang` in the directory with the completions.
|
62 | 69 |
|
63 | 70 | If you're using Fish, you can add the following to your `~/.config/fish/config.fish` file:
|
| 71 | +
|
64 | 72 | ```
|
65 | 73 | defang completion fish | source
|
66 | 74 | ```
|
67 | 75 |
|
68 | 76 | If you're using Powershell, you can add the following to your `$HOME\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` file:
|
| 77 | +
|
69 | 78 | ```
|
70 | 79 | Invoke-Expression -Command (defang completion powershell | Out-String)
|
71 | 80 | ```
|
72 | 81 |
|
73 | 82 | ## Environment Variables
|
| 83 | +
|
74 | 84 | The Defang CLI recognizes the following environment variables:
|
75 |
| -* `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the name in the `compose.yaml` file |
76 |
| -* `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login` |
77 |
| -* `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…` |
78 |
| -* `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta` |
79 |
| -* `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging |
80 |
| -* `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false` |
81 |
| -* `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev` |
82 |
| -* `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false` |
83 |
| -* `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false` |
84 |
| -* `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, or `defang` |
85 |
| -* `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal |
86 |
| -* `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local` |
87 |
| -* `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state` |
| 85 | +
|
| 86 | +- `COMPOSE_PROJECT_NAME` - The name of the project to use; overrides the name in the `compose.yaml` file |
| 87 | +- `DEFANG_ACCESS_TOKEN` - The access token to use for authentication; if not specified, uses token from `defang login` |
| 88 | +- `DEFANG_CD_BUCKET` - The S3 bucket to use for the BYOC CD pipeline; defaults to `defang-cd-bucket-…` |
| 89 | +- `DEFANG_CD_IMAGE` - The image to use for the Continuous Deployment (CD) pipeline; defaults to `public.ecr.aws/defang-io/cd:public-beta` |
| 90 | +- `DEFANG_DEBUG` - set this to `1` or `true` to enable debug logging |
| 91 | +- `DEFANG_DISABLE_ANALYTICS` - If set to `true`, disables sending analytics to Defang; defaults to `false` |
| 92 | +- `DEFANG_FABRIC` - The address of the Defang Fabric to use; defaults to `fabric-prod1.defang.dev` |
| 93 | +- `DEFANG_HIDE_HINTS` - If set to `true`, hides hints in the CLI output; defaults to `false` |
| 94 | +- `DEFANG_HIDE_UPDATE` - If set to `true`, hides the update notification; defaults to `false` |
| 95 | +- `DEFANG_PROVIDER` - The name of the cloud provider to use, `auto` (default), `aws`, or `defang` |
| 96 | +- `NO_COLOR` - If set to any value, disables color output; by default, color output is enabled depending on the terminal |
| 97 | +- `TZ` - The timezone to use for log timestamps: an IANA TZ name like `UTC` or `Europe/Amsterdam`; defaults to `Local` |
| 98 | +- `XDG_STATE_HOME` - The directory to use for storing state; defaults to `~/.local/state` |
0 commit comments