# Use the yaya CLI

Sign in with an account key, publish a folder, and manage versions from a terminal.

Source: https://yaya.page/support/articles/developers/use-the-yaya-cli
Last updated: 2026-10-02

## Before you start
- The `yaya` command on your machine.
- A signed-in browser. About 5 minutes.

## Sign the CLI in
1. Run `yaya login key`. It opens **Account API keys** in your browser.
2. Create a key with only the scopes you need and copy it.
3. Paste it at the hidden terminal prompt.
4. Wait for the check. The CLI saves the key to `~/.config/yaya/credentials.json` only if the key is valid.

The CLI defaults to `https://api.yaya.page`. Add `--base-url <url>` to use another origin.

## Everyday commands
```
yaya workspace list
yaya publish --dir ./site --tenant-id <id>
yaya versions list --tenant-id <id>
yaya versions restore --tenant-id <id> --version-id <id>
yaya domains check --host shop.example.com
yaya support send --subject "Question" --message "..."
```

Run `yaya` with no arguments to print every command. See [CLI command reference](/support/articles/developers/cli-command-reference) for each one and its flags.

## Use it in scripts
Set `YAYA_API_KEY` for a workspace key or `YAYA_ACCOUNT_KEY` for an account key. Or pipe a key into `yaya login --key-stdin`.

> Warning: Never pass a key as a command argument. It ends up in your shell history.

## Fix common problems
**401 after login.** The key was revoked or has expired. Make a new one. See [Fix API authentication errors](/support/articles/developers/fix-api-authentication-errors).

**Login did not save.** A failed or cancelled login leaves your old credentials unchanged. Run it again.