Skip to content

Commit c4dc210

Browse files
committed
Normalize docs command examples to npx
1 parent c821f31 commit c4dc210

5 files changed

Lines changed: 9 additions & 8 deletions

File tree

content/docs/getting-started/installation.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,11 @@ globally:
5757
npm install -g rollberry
5858
```
5959

60-
Then run it directly:
60+
This makes the `rollberry` binary available globally, but this docs site keeps
61+
all command examples on the same `npx` form for consistency:
6162

6263
```bash
63-
rollberry capture https://example.com --out ./artifacts/example.mp4
64+
npx rollberry capture https://example.com --out ./artifacts/example.mp4
6465
```
6566

6667
## Chromium behavior

content/docs/getting-started/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ launch-ready videos with a real Chromium browser and FFmpeg.
1111

1212
It supports two primary workflows:
1313

14-
- `rollberry capture` for one-off URLs or multi-page stitched captures
15-
- `rollberry render` for project JSON files with scenes, actions, timelines,
14+
- `npx rollberry capture` for one-off URLs or multi-page stitched captures
15+
- `npx rollberry render` for project JSON files with scenes, actions, timelines,
1616
and multiple outputs
1717

1818
Both workflows write machine-readable sidecars so you can automate around the

content/docs/guides/project-rendering.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Project Rendering
3-
description: Use rollberry render with a project JSON file for repeatable scenes, actions, timelines, and multiple outputs.
3+
description: Use npx rollberry render with a project JSON file for repeatable scenes, actions, timelines, and multiple outputs.
44
order: 0
55
---
66

content/docs/reference/cli-options.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ order: 0
77
## Commands
88

99
```bash
10-
rollberry capture <url...> [options]
11-
rollberry render <project.json> [options]
10+
npx rollberry capture <url...> [options]
11+
npx rollberry render <project.json> [options]
1212
```
1313

1414
## Capture options

content/docs/troubleshooting/common-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The current implementation caps total frames at `36000`.
121121

122122
## Render project validation failed
123123

124-
**Symptom:** `rollberry render` exits before capture begins with a project-file
124+
**Symptom:** `npx rollberry render` exits before capture begins with a project-file
125125
validation error.
126126

127127
**Fix:** Check:

0 commit comments

Comments
 (0)