Skip to content

Commit dc91d77

Browse files
committed
docs: update CLI guide with v0.2.0 commands
Add documentation for new CLI commands: - init: Create new Actor projects from templates - dev: Local development mode with hot reload - status: Check run status with watch mode Update logs command docs: - Add --limit option (default 1000)
1 parent 09e0cf3 commit dc91d77

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

src/docs/cli.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,80 @@ crc <command>
2626

2727
## Commands
2828

29+
### `init`
30+
31+
Create a new Actor project from a template.
32+
33+
```bash
34+
crawlee-cloud init [name] [options]
35+
```
36+
37+
**Options:**
38+
39+
| Flag | Description |
40+
| ---------------- | ------------------------------ |
41+
| `--template, -t` | Template ID from Apify catalog |
42+
43+
**Example:**
44+
45+
```bash
46+
# Interactive mode - prompts for name and template
47+
crawlee-cloud init
48+
49+
# Quick start with specific template
50+
crawlee-cloud init my-scraper --template ts-crawlee-cheerio
51+
```
52+
53+
---
54+
55+
### `dev`
56+
57+
Run an Actor locally in development mode.
58+
59+
```bash
60+
crawlee-cloud dev [options]
61+
```
62+
63+
**Options:**
64+
65+
| Flag | Description |
66+
| ------------- | ---------------------------------- |
67+
| `--watch, -w` | Enable file watching & auto-reload |
68+
69+
**Example:**
70+
71+
```bash
72+
cd my-actor
73+
crawlee-cloud dev # Run once
74+
crawlee-cloud dev --watch # Run with hot reload
75+
```
76+
77+
---
78+
79+
### `status`
80+
81+
Check the status of an Actor run.
82+
83+
```bash
84+
crawlee-cloud status <run-id> [options]
85+
```
86+
87+
**Options:**
88+
89+
| Flag | Description |
90+
| ---------------- | ------------------------- |
91+
| `--watch, -w` | Watch for status updates |
92+
| `--interval, -i` | Watch interval in seconds |
93+
94+
**Example:**
95+
96+
```bash
97+
crawlee-cloud status abc123
98+
crawlee-cloud status abc123 --watch --interval 5
99+
```
100+
101+
---
102+
29103
### `login`
30104

31105
Authenticate with your Crawlee Cloud server.

0 commit comments

Comments
 (0)