Skip to content

Improve Installation Docs #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Improve Installation Docs #95

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0660faa
avoid using headers since they dont work with tabs
jordanstephens Sep 20, 2024
f50cd4e
add nix tab
jordanstephens Sep 20, 2024
6e24c69
link to latest release page
jordanstephens Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions docs/getting-started/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We offer a few different ways to install the Defang CLI. You can use a bash scri

<Tabs>
<TabItem value="bash" label="Bash">
## Using a Bash Script
**Using a Bash Script**

You can install the Defang CLI using a bash script. Run the following command in your terminal:

Expand All @@ -26,7 +26,7 @@ We offer a few different ways to install the Defang CLI. You can use a bash scri
The script will try to download the appropriate binary for your operating system and architecture, add it to `~/.local/bin`, and add `~/.local/bin` to your `PATH` if it's not already there, with your permission. If you do not provide permission it will print an appropriate instruction for you to follow to add it manually. You can also customize the installation directory by setting the `INSTALL_DIR` environment variable before running the script.
</TabItem>
<TabItem value="homebrew" label="Homebrew" default>
## Using Homebrew
**Using Homebrew**

You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal:

Expand All @@ -35,17 +35,24 @@ We offer a few different ways to install the Defang CLI. You can use a bash scri
```
</TabItem>
<TabItem value="winget" label="Winget">
## Using Winget
**Using Winget**

On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal:

```powershell
winget install defang
```
</TabItem>
<TabItem value="nix" label="Nix">
**Using Nix**

```bash
nix profile install github:DefangLabs/defang#defang-bin --refresh
```
</TabItem>
<TabItem value="direct" label="Direct Download">
## Direct Download
**Direct Download**

You can find the latest version of the Defang CLI on the [releases page](https://github.com/DefangLabs/defang/releases). Just download the appropriate binary for your operating system and architecture, and put it somewhere in your `PATH`.
You can find the latest version of the Defang CLI on the [latest release page](https://github.com/DefangLabs/defang/releases/latest). Just download the appropriate binary for your operating system and architecture, and put it somewhere in your `PATH`.
</TabItem>
</Tabs>
Loading