# CLI reference

Every clanker command, with its arguments, options and examples, built from the CLI itself.

The `clanker` CLI runs your product's tests and does everything the website does, from your
terminal or a clanker's shell. It calls the same [API](https://docs.clankership.com/api.md) as the website, signed in as you, so
your role decides what it may change.

```bash
curl -fsSL https://clankership.com/install.sh | sh
clanker auth login
clanker link acme --product storefront
```

`clanker auth login` opens the website to approve the sign-in. `clanker link` saves the workspace
in this repository's `clanker.json`, so later commands use it; `--workspace` names another one for
a single command.

Every command prints the API's JSON and exits `2` on a usage error. Run `clanker <command> --help`
for the same arguments, options and examples these pages show. The CLI updates itself in the
background: a new version reaches your computer within an hour of its release, and
`clanker update` installs it now.

The commands below are grouped as `clanker --help` lists them.