Skip to content

Commit 781780d

Browse files
authored
Merge pull request #92 from DefangLabs/jordan/installation-tabs
Installation Instruction Tabs
2 parents f6c8509 + fa0898c commit 781780d

File tree

2 files changed

+37
-29
lines changed

2 files changed

+37
-29
lines changed

docs/getting-started/getting-started.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,21 @@ Defang supports various ways of creating and deploying services to the cloud. Th
4747
By default, all the output (stdout and stderr) from your app is logged. You can view these logs in real-time. You can view logs for all your services, one service, or even one specific deployment of a service.
4848

4949
- From the CLI:
50-
50+
5151
```tsx
5252
defang tail --name service1
5353
```
54-
54+
5555
- From the Defang Portal:
56-
57-
[https://portal.defang.dev/](https://portal.defang.dev/)
56+
57+
[https://portal.defang.dev/](https://portal.defang.dev/)
5858

5959

6060
:::info
6161
* To learn more about observability in Defang, check out the [observability page](../concepts/observability.md).
6262
* Note that the Defang Portal only displays services deployed to Defang Playground.
6363
:::
64-
64+
6565

6666
### Update Services
6767

@@ -70,4 +70,3 @@ To update your app (for example, updating the base image of your container, or m
7070
:::info
7171
If you are using [compose files](../concepts/compose.md) to define your services, you can add/remove services, make changes to code, etc. When you run `defang compose up`, the update will be diffed against the current state and any necessary changes will be applied to make the current state match the desired state.
7272
:::
73-

docs/getting-started/installing.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,49 @@ sidebar_position: 100
33
title: Installing
44
description: How to install Defang.
55
---
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
68

7-
# Installing
9+
# How to Install Defang
810

911
Defang doesn't require installing anything in your cloud, but you will need to install the [open source](https://github.com/DefangLabs/defang) Defang command line interface (CLI) to interact with your Defang resources and account.
1012

11-
We offer a few different ways to install the Defang CLI. You can use Homebrew, a bash script, Winget, or download the binary directly.
13+
We offer a few different ways to install the Defang CLI. You can use a bash script, Homebrew, Winget, or you can download the binary directly.
1214

13-
## Using Homebrew
1415

15-
You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal:
16+
<Tabs>
17+
<TabItem value="bash" label="Bash">
18+
## Using a Bash Script
1619

17-
```bash
18-
brew install DefangLabs/defang/defang
19-
```
20+
You can install the Defang CLI using a bash script. Run the following command in your terminal:
2021

21-
## Using a Bash Script
22+
```bash
23+
. <(curl -Ls s.defang.io/install)
24+
```
2225

23-
You can install the Defang CLI using a bash script. Run the following command in your terminal:
26+
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.
27+
</TabItem>
28+
<TabItem value="homebrew" label="Homebrew" default>
29+
## Using Homebrew
2430

25-
```bash
26-
. <(curl -Ls s.defang.io/install)
27-
```
31+
You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal:
2832

29-
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.
33+
```bash
34+
brew install DefangLabs/defang/defang
35+
```
36+
</TabItem>
37+
<TabItem value="winget" label="Winget">
38+
## Using Winget
3039

31-
## Using Winget
40+
On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal:
3241

33-
On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal:
34-
35-
```powershell
36-
winget install defang
37-
```
38-
39-
## Direct Download
40-
41-
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`.
42+
```powershell
43+
winget install defang
44+
```
45+
</TabItem>
46+
<TabItem value="direct" label="Direct Download">
47+
## Direct Download
4248

49+
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`.
50+
</TabItem>
51+
</Tabs>

0 commit comments

Comments
 (0)