Installation & Setup

Installation

Wharfie is distributed as a single executable, you can download a specific release from the github releases

curl -fsSL https://raw.githubusercontent.com/wharfie/wharfie/master/install.sh | bash

For Windows:

iex (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/wharfie/wharfie/master/install.ps1" -UseBasicParsing).Content

Validate AWS credentials

aws sts get-caller-identity

If that command returns a valid aws identity, you are ready to continue. For configuring the AWS CLI refer to its docs

Configure Wharfie CLI

wharfie config

You will need to select what AWS region to deploy wharfie in, as a rule of thumb running wharfie in the same region that your data is stored in will be cheaper, due to transfer costs. You will also need to select a wharfie deployment name which will be how you target what specific deployment you will use when running wharfie cli commands. For more information on deployments refer to the project structure docs