diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index 99034b047..9e2304de1 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -47,21 +47,21 @@ Defang supports various ways of creating and deploying services to the cloud. Th 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. - From the CLI: - + ```tsx defang tail --name service1 ``` - + - From the Defang Portal: - - [https://portal.defang.dev/](https://portal.defang.dev/) + + [https://portal.defang.dev/](https://portal.defang.dev/) :::info * To learn more about observability in Defang, check out the [observability page](../concepts/observability.md). * Note that the Defang Portal only displays services deployed to Defang Playground. ::: - + ### Update Services @@ -70,4 +70,3 @@ To update your app (for example, updating the base image of your container, or m :::info 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. ::: - diff --git a/docs/getting-started/installing.md b/docs/getting-started/installing.md index 6ee9dbf3c..73111037c 100644 --- a/docs/getting-started/installing.md +++ b/docs/getting-started/installing.md @@ -3,40 +3,49 @@ sidebar_position: 100 title: Installing description: How to install Defang. --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; -# Installing +# How to Install Defang 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. -We offer a few different ways to install the Defang CLI. You can use Homebrew, a bash script, Winget, or download the binary directly. +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. -## Using Homebrew -You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal: + + + ## Using a Bash Script -```bash -brew install DefangLabs/defang/defang -``` + You can install the Defang CLI using a bash script. Run the following command in your terminal: -## Using a Bash Script + ```bash + . <(curl -Ls s.defang.io/install) + ``` -You can install the Defang CLI using a bash script. Run the following command in your terminal: + 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. + + + ## Using Homebrew -```bash -. <(curl -Ls s.defang.io/install) -``` + You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal: -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. + ```bash + brew install DefangLabs/defang/defang + ``` + + + ## Using Winget -## Using Winget + On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal: -On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal: - -```powershell -winget install defang -``` - -## 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`. + ```powershell + winget install defang + ``` + + + ## 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`. + +