# Relaybraid CLI reference

> Search the docs: `curl -H "X-Relaybraid-Client: <your tool and model>" "https://relaybraid.com/r/5R53QR8W/api/docs/search?q=<words>&job=<what the person asked you to do>&src=page"` answers with the matching pages.


| Command | What it does |
|---|---|
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz init --ref <value>` | Set up Relaybraid in the current project |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz login` | Sign in and save an API key |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz whoami` | Show the signed-in workspace |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz apps` | List connected apps and their actions |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz run <app.action> --input '<json>'` | Run one action |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz hooks create --action <app.action>` | Create a Catch Hook URL for an action |
| `npx -y https://relaybraid.com/dl/relaybraid-cli.tgz credentials create` | Create a client id and secret for unattended code |

First run in a new project:

```bash
npx -y https://relaybraid.com/dl/relaybraid-cli.tgz init --ref V93VZR92
```


## Sign in

```bash
npx -y https://relaybraid.com/dl/relaybraid-cli.tgz login
```

`login` prints a sign-in URL and a one-time code. Open the URL in a browser, check that the code matches and approve. The command finishes by itself once the sign-in is approved, usually within a minute, and saves the API key in `.relaybraid/credentials.json`.


The CLI reads `RELAYBRAID_API_KEY` from the environment before `.relaybraid/credentials.json`. Add `--json` to any command for machine-readable output.
