Skip to content

Commit 1ef1cb1

Browse files
chanceaclarkclaude
andauthored
docs: TRAC-167 Add logs tail command to CLI reference (#1294)
Jira: [TRAC-167](https://bigcommercecloud.atlassian.net/browse/TRAC-167) ## What/Why? Adds the `catalyst logs tail` command to the Catalyst CLI reference docs. This was missed in the initial Native Hosting CLI documentation. Covers parameters, the five output format options (`default`, `short`, `request`, `json`, `pretty`), and usage examples. ## Rollout/Rollback Documentation-only change. No rollout or rollback needed. ## Testing - Verify the new `logs tail` section renders correctly on the docs site - Confirm parameter table and format descriptions match the CLI implementation in `packages/catalyst/src/cli/commands/logs.ts` [TRAC-167]: https://bigcommercecloud.atlassian.net/browse/TRAC-167?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ Co-authored-by: Claude <noreply@anthropic.com>
1 parent dc6ff29 commit 1ef1cb1

File tree

1 file changed

+40
-0
lines changed
  • docs/storefront/catalyst/reference

1 file changed

+40
-0
lines changed

docs/storefront/catalyst/reference/cli.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,46 @@ pnpm catalyst deploy --secret BIGCOMMERCE_STORE_HASH=<YOUR_STORE_HASH> --secret
156156

157157
---
158158

159+
## logs tail
160+
161+
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).
162+
163+
### Parameters
164+
165+
| Parameter | Required | Description |
166+
| :---- | :---- | :---- |
167+
| `--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. |
168+
| `--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. |
169+
| `--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. |
170+
| `--format <format>` | No | Output format for log events. Choices: `json`, `pretty`, `default`, `short`, `request`. Defaults to `default`. |
171+
| `--api-host <host>` | No | API host to connect to. Defaults to `api.bigcommerce.com`. |
172+
173+
The available formats are:
174+
175+
- `default``[timestamp] [LEVEL] message`
176+
- `short` — message only
177+
- `request``[timestamp] [LEVEL] METHOD URL (status_code) message`
178+
- `json` — raw JSON output
179+
- `pretty` — pretty-printed JSON
180+
181+
### Example
182+
183+
```shell
184+
pnpm catalyst logs tail
185+
```
186+
187+
```shell
188+
# Tail logs with request format
189+
pnpm catalyst logs tail --format request
190+
```
191+
192+
```shell
193+
# Tail logs as raw JSON (useful for piping to other tools)
194+
pnpm catalyst logs tail --format json
195+
```
196+
197+
---
198+
159199
## project create
160200

161201
Create a BigCommerce infrastructure project.

0 commit comments

Comments
 (0)