Skip to content

Commit 22b46d6

Browse files
authored
docs: add pixelshot CLI usage examples (#62)
* docs: add pixelshot CLI usage examples to README * docs: use real tested URLs in pixelshot CLI examples * docs: move CLI examples below programmatic section
1 parent da4060a commit 22b46d6

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,20 @@ from pixelrag_render import render_url
214214
tiles = render_url("https://en.wikipedia.org/wiki/Python", "./tiles")
215215
```
216216

217+
The same rendering is available as a CLI — `pixelshot` ships with `pip install pixelrag`:
218+
219+
```bash
220+
# Web page → tiles (headless Chromium via CDP)
221+
pixelshot https://en.wikipedia.org/wiki/Python -o ./tiles
222+
223+
# PDF → tiles (requires poppler; install the pdf extra: pip install 'pixelrag[pdf]')
224+
curl -sL -o paper.pdf https://arxiv.org/pdf/2503.09516
225+
pixelshot paper.pdf -o ./tiles --dpi 200
226+
227+
# URLs and local files can be mixed freely
228+
pixelshot https://github.com/StarTrail-org/PixelRAG paper.pdf -o ./tiles
229+
```
230+
217231
### Embed tools (standalone)
218232

219233
Each stage runs independently, without the orchestrator:

0 commit comments

Comments
 (0)