Skip to content

Commit b885655

Browse files
committed
docs: update new watcher startup
1 parent 9170a9e commit b885655

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,19 @@ aw-nextblock provides structure without rigidity. Plans are guides, not rules. Y
5757
Use `aw-nextblock` for session management:
5858

5959
```bash
60-
aw-nextblock start <plan.yaml> # Start a work session
61-
aw-nextblock next # Move to next block
62-
aw-nextblock status # Check current status
63-
aw-nextblock stop # Stop current session
60+
aw-nextblock # Start the watcher process
61+
aw-nextblock start <plan.yaml> # Start a work session
62+
aw-nextblock next # Move to next block
63+
aw-nextblock status # Check current status
64+
aw-nextblock stop # Stop current session
65+
aw-nextblock --help # Show help
66+
aw-nextblock --version # Show version
67+
```
68+
69+
**Watcher-specific flags:**
70+
```bash
71+
aw-nextblock --testing # Start watcher in testing mode
72+
aw-nextblock --verbose # Enable verbose logging
6473
```
6574

6675
### Triggering Next
@@ -101,7 +110,7 @@ Durations are estimates, not limits.
101110
aw-nextblock start plan.yaml
102111
```
103112

104-
This creates a session file and start its aw watcher process.
113+
This creates a session.json file. The watcher process monitors this file.
105114

106115
#### 3. Work and Advance
107116

@@ -144,6 +153,17 @@ After completing your work session, use the custom visualization in ActivityWatc
144153
- **Linux/macOS**: Copy to `/usr/local/bin/` or add to your `$PATH`
145154
- **Windows**: Add to a directory in your `PATH` environment variable
146155

156+
### Autostart Watcher
157+
158+
Optionally, add `aw-nextblock` to autostart in your `aw-qt.toml` file in the [config directory](https://docs.activitywatch.net/en/latest/directories.html#config).
159+
160+
Add `aw-nextblock` to the `autostart_modules` list:
161+
162+
```toml
163+
[aw-qt]
164+
autostart_modules = ["aw-server", "aw-watcher-afk", "aw-watcher-window", "aw-nextblock"]
165+
```
166+
147167
### Optional: Setup Visualization (Experimental Feature)
148168

149169
The visualization allows you to see your planned vs actual activity data in ActivityWatch's web UI. This is an **experimental feature** that requires manual configuration.
@@ -176,7 +196,7 @@ aw-watcher-nextblock = "/path/to/your/visualization/folder/"
176196

177197
### Watcher Configuration
178198

179-
The watcher (started with `aw-nextblock start`) can be configured by creating a `aw-watcher-nextblock.toml` file in the watcher's configuration directory:
199+
Create a `aw-watcher-nextblock.toml` file in the watcher's configuration directory:
180200

181201
**Linux** (`~/.config/activitywatch/aw-watcher-nextblock/aw-watcher-nextblock.toml`)
182202

@@ -202,15 +222,7 @@ notify_after_every_minutes = 5
202222

203223
# Time scaling factor (only used for testing)
204224
time_scale_factor = 1
205-
206-
# Testing mode
207-
testing = false
208-
209-
# Verbose logging
210-
verbose_logging = false
211225
```
212-
213226
## Contributing
214227

215-
Contributions welcome. Open an issue to discuss changes before submitting PRs.
216-
228+
Contributions welcome. Open an issue to discuss changes before submitting PRs.

0 commit comments

Comments
 (0)