Getting Started

Build the binary

Build the CLI from the api/ directory:

cd api
make build-cli

The compiled binary is written to:

api/bin/gaard

Run it directly:

./bin/gaard version

If you want gaard available on your PATH, install the built binary into a directory that is already on your shell path.

First login

Authenticate against the default Gaard app:

./bin/gaard login

The command prompts for:

• A browser sign-in flow

The CLI opens the browser automatically when possible. If it cannot, it prints a URL you can open manually.

After you approve the request in the browser, the CLI creates a personal access token and stores it in the active config file.

To log into a different environment explicitly:

./bin/gaard login --api http://127.0.0.1:8004 --name local

First useful commands

Check the current identity:

./bin/gaard whoami

List configured environments:

./bin/gaard ctx list

Print structured output for automation:

./bin/gaard whoami -o json

Global flags

Most commands support these global flags:

• -c, --context to override the context for a single command
• -t, --tenant to override the tenant for a single command
• -o, --output to choose table or json
• --no-color to disable ANSI colors
• -v, --verbose for verbose logging

Built-in help

The CLI ships with command help:

./bin/gaard --help
./bin/gaard login --help
./bin/gaard ctx --help
./bin/gaard tenant --help