diff --git a/docs/docs/getting-started/cli.md b/docs/docs/getting-started/cli.md index cedc7b9795..3e581c1d19 100644 --- a/docs/docs/getting-started/cli.md +++ b/docs/docs/getting-started/cli.md @@ -3,11 +3,10 @@ title: Command Line Interface sidebar_label: Overview --- -CLI -Build, test and manage Airy right from the Terminal. +## CLI -The Airy CLI is a developer tool to help you help build, test, and manage Airy directly from your terminal. +> _Start, manage, and test instances of Airy Core right from the terminal_ -The CLI is easy to install, works on macOS, Windows, and Linux. +The Airy CLI is a developer tool to help you build, test, and manage Airy directly from your terminal. -Step 1: Install the Airy CLI +The CLI is easy to [install](/getting-started/installation.md) and works on macOS, Windows, and Linux. diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md index 09b9fd6f92..762bd3841d 100644 --- a/docs/docs/getting-started/installation.md +++ b/docs/docs/getting-started/installation.md @@ -4,6 +4,111 @@ sidebar_label: Installation --- import useBaseUrl from '@docusaurus/useBaseUrl'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +You can run the entire Airy Core on your machine [inside an isolated Vagrant box](/getting-started/deployment/vagrant.md). We recommend to install the Aiy CLI first which will aid you in the process of installing and managing your Airy Core instance. + +## Install the Airy CLI + +### Download the binary with curl + +1. Download the latest release with: + + + + +```bash +curl "https://airy-core-binaries.s3.amazonaws.com/$(curl -L -s https://airy-core-binaries.s3.amazonaws.com/stable.txt)/darwin/amd64/airy" -o "airy" +``` + +:::note + +To download a specific version, replace the `$(curl -L -s https://airy-core-binaries.s3.amazonaws.com/stable.txt)` portion of the command with the specific version. + +For example, to download version 0.6.0 on macOS, type: + +curl https://airy-core-binaries.s3.amazonaws.com/0.6.0/darwin/amd64/airy -o "airy" +::: + + + + +```bash +curl -LO "https://airy-core-binaries.s3.amazonaws.com/$(curl -L -s https://airy-core-binaries.s3.amazonaws.com/stable.txt)/linux/amd64/airy" -o "airy" +``` + +:::note + +To download a specific version, replace the `$(curl -L -s https://airy-core-binaries.s3.amazonaws.com/stable.txt)` portion of the command with the specific version. + +For example, to download version 0.6.0 on Linux, type: + +curl https://airy-core-binaries.s3.amazonaws.com/0.6.0/linux/amd64/airy -o "airy" +::: + + + + + + + + +1. Validate the binary (optional) +2. Make the **airy** binary executable. + +```bash +chmod +x ./airy +``` + +4. Move the **airy** binary to a file location on your system PATH. + +``` +sudo mv ./airy /usr/local/bin/airy && \ +sudo chown root: /usr/local/bin/airy +``` + + + + + +2. Validate the binary (optional) +3. Install **airy** + +```bash +sudo install -o root -g root -m 0755 airy /usr/local/bin/airy +``` + + + + +### Build the Airy CLI from source + +1. Build the cli target with Bazel + +```bash +bazel build //infrastructure/cli:airy +``` + +2. Move the **airy** binary to a file location on your system PATH. + +```bash +sudo cp bazel-out/darwin-fastbuild/bin/infrastructure/cli/airy /usr/local/bin/airy +``` ## Bootstrap Airy Core