Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/storefront/catalyst/reference/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,46 @@ pnpm catalyst deploy --secret BIGCOMMERCE_STORE_HASH=<YOUR_STORE_HASH> --secret

---

## logs tail

Tail live logs from your deployed application. Streams log output in real time using Server-Sent Events (SSE). The stream automatically reconnects on transient errors (up to 5 retries).

### Parameters

| Parameter | Required | Description |
| :---- | :---- | :---- |
| `--store-hash <hash>` | **Yes** | The BigCommerce store hash (found in the URL of your store's Control Panel). Can also be set via an environment variable named `CATALYST_STORE_HASH` or the `.bigcommerce/project.json` file. |
| `--access-token <token>` | **Yes** | Your BigCommerce access token. Can also be set via an environment variable named `CATALYST_ACCESS_TOKEN` or the `.bigcommerce/project.json` file. |
| `--project-uuid <uuid>` | No | The project UUID. Can also be set via an environment variable named `CATALYST_PROJECT_UUID` or the `.bigcommerce/project.json` file. |
| `--format <format>` | No | Output format for log events. Choices: `json`, `pretty`, `default`, `short`, `request`. Defaults to `default`. |
| `--api-host <host>` | No | API host to connect to. Defaults to `api.bigcommerce.com`. |

The available formats are:

- `default` — `[timestamp] [LEVEL] message`
- `short` — message only
- `request` — `[timestamp] [LEVEL] METHOD URL (status_code) message`
- `json` — raw JSON output
- `pretty` — pretty-printed JSON

### Example

```shell
pnpm catalyst logs tail
```

```shell
# Tail logs with request format
pnpm catalyst logs tail --format request
```

```shell
# Tail logs as raw JSON (useful for piping to other tools)
pnpm catalyst logs tail --format json
```

---

## project create

Create a BigCommerce infrastructure project.
Expand Down
Loading