Skip to content
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.

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

chore: update getting started doc to include brew install #720

Merged
merged 5 commits into from
Oct 9, 2024
Merged
Changes from 4 commits
Commits
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
59 changes: 37 additions & 22 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,72 @@

## Installation

Currently you can install Lula a couple different ways. A brew formulae is in the plan, but not currently implemented. Lula is currently only compatible with Linux/MacOS distributions.
Currently, you can install Lula in a couple of different ways: using Homebrew or from source. Lula is compatible only with Linux and macOS distributions.
brandtkeller marked this conversation as resolved.
Show resolved Hide resolved

### Homebrew

1) [Homebrew](https://brew.sh/) is a package manager for macOS and Linux. You can install Lula with Homebrew by running the following:

```shell
brew tap defenseunicorns/tap && brew install lula
```

### From Source

1) Clone the repository to your local machine and change into the `lula` directory

```shell
git clone https://github.com/defenseunicorns/lula.git && cd lula
```

2) While in the `lula` directory, compile the tool into an executable binary. This outputs the `lula` binary to the `bin` directory.

```shell
make build
```

3) On most Linux distributions, install the binary onto your $PATH by moving the downloaded binary to the /usr/local/bin directory:

```shell
sudo mv ./bin/lula /usr/local/bin/lula
```

### Download

1) Navigate to the Latest Release Page:
Open your web browser and go to the following URL to access the latest release of Lula:
https://github.com/defenseunicorns/lula/releases/latest
1. Navigate to the Latest Release Page:
Open your web browser and go to the following URL to access the latest release of Lula:

2) Download the Binary:
On the latest release page, find and download the appropriate binary for your operating system. E.g., `lula_<version>_Linux_amd64`
[https://github.com/defenseunicorns/lula/releases/latest](https://github.com/defenseunicorns/lula/releases/latest)

3) Download the checksums.txt:
In the list of assets on the release page, locate and download the checksums.txt file. This file contains the checksums for all the binaries in the release.
2. Download the Binary:
On the latest release page, find and download the appropriate binary for your operating system. E.g., `lula_<version>_Linux_amd64`

4) Verify the Download:
After downloading the binary and checksums.txt, you should verify the integrity of the binary using the checksum provided:
3. Download the checksums.txt:
In the list of assets on the release page, locate and download the checksums.txt file. This file contains the checksums for all the binaries in the release.

4. Verify the Download:
After downloading the binary and checksums.txt, you should verify the integrity of the binary using the checksum provided:
* Open a terminal and navigate to the directory where you downloaded the binary and checksums.txt.
* Run the following command to verify the checksum if using Linux:
```shell
sha256sum -c checksums.txt --ignore-missing
```

```shell
sha256sum -c checksums.txt --ignore-missing
```

* Run the following command to verify the checksum if using MacOS:
```shell
shasum -a 256 -c checksums.txt --ignore-missing
```

5) On most Linux distributions, install the binary onto your $PATH by moving the downloaded binary to the /usr/local/bin directory:
```shell
sudo mv ./download/path/lula_<version>_Linux_amd64 /usr/local/bin/lula
```
```shell
shasum -a 256 -c checksums.txt --ignore-missing
```

5. On most Linux distributions, install the binary onto your $PATH by moving the downloaded binary to the /usr/local/bin directory:

```shell
sudo mv ./download/path/lula_<version>_Linux_amd64 /usr/local/bin/lula

## Quick Start

See the following tutorials for some introductory lessons on how to use Lula. If you are unfamiliar with Lula, the best place to start is the "Simple Demo".
See the following tutorials for some introductory lessons on how to use Lula. If you are unfamiliar with Lula, the best place to start is the "Simple Demo".

### Tutorials

Expand All @@ -67,4 +82,4 @@ Developing Lula Validations can sometimes be more art than science, but generall

### Configuration

Lula supports the addition of a configuration file for specifying CLI flags and templating values. See our [configuration](./configuration.md) guide for more information.
Lula supports the addition of a configuration file for specifying CLI flags and templating values. See our [configuration](./configuration.md) guide for more information.