terrarium/setup.md at main · nonfx/terrarium · GitHub

79 lines (52 loc) · 2.23 KB

CLI Installation & Setup

CLI connects with sqlite Database to store the persistent data.

Install CLI

There are multiple ways to install the terrarium CLI:
- Using Homebrew (for MacOS or Linux)
```
brew tap cldcvr/tap
brew install terrarium
```
- Clone the repo and compile:
```
git clone git@github.com:cldcvr/terrarium.git
cd terrarium
make install
```
- Install using go package manager
```
go install github.com/cldcvr/terrarium/src/cli/terrarium@latest
```
- Download pre-compiled binary from GitHub Release
  - There are downloadable assets associated with each CLI release in Github. These can be downloaded directly from the Terrarium Github release page
  - The release assets can also be downloaded via wget or curl.
  - The below steps configure terrarium cli version 0.5. Similar steps can be followed to configure other versions of CLI.
```
wget https://github.com/cldcvr/terrarium/releases/download/v0.5/terrarium-v0.5-macos-arm64.tar.gz
```
```
curl -LO https://github.com/cldcvr/terrarium/releases/download/v0.5/terrarium-v0.5-macos-arm64.tar.gz
```
  - Once the the file is downloaded, the tar utility can be used to extract the binary.
```
tar -xzvf terrarium-v0.5-macos-arm64.tar.gz
```
  - To make the binary runnable from anywhere, it should be moved to a directory that is included in system's PATH.
    
    Common directories for user binaries include /usr/local/bin or ~/bin (if it exists and is in PATH).
```
mv terrarium /usr/local/bin/
```

Seed & Run Database

rm ~/.terrarium/farm.sqlite
terrarium farm update

Farm Database Updates

To update the farm data when a new farm repo release is available, use the following command:

rm ~/.terrarium/farm.sqlite
terrarium farm update

Environment Variables

For the list of available configurations, refer to the CLI config package

CLI config is to be set in ~/.terrarium/config.yaml file or by exporting the environment variables.