Skip to content

Commit 0178c20

Browse files
docs: Update docs w/ newest flags (#109)
2 parents bbf29f9 + ddc1484 commit 0178c20

1 file changed

Lines changed: 21 additions & 14 deletions

File tree

docs/usage.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ View your time tracking history.
101101
- `--project "name"` - Filter entries by project name
102102
- `--today` - Show only today's entries
103103
- `--week` - Show this week's entries
104+
- `--date` - Show a specific date's entries
104105

105106
**Examples:**
106107

@@ -111,6 +112,7 @@ tmpo log --project "Client Work" # Filter by global project
111112
tmpo log --milestone "Sprint 1" # Filter by milestone
112113
tmpo log --today # Show today's entries
113114
tmpo log --week # Show this week's entries
115+
tmpo log --date "2026-01-15" # Show January 15th, 2026 entries
114116
```
115117

116118
### `tmpo stats`
@@ -122,13 +124,15 @@ Display statistics about your tracked time.
122124
- `--today` - Show only today's statistics
123125
- `--week` - Show this week's statistics
124126
- `--month` - Show this month's statistics
127+
- `--date` - Show a specific date's statistics
125128

126129
**Examples:**
127130

128131
```bash
129132
tmpo stats # All-time stats
130133
tmpo stats --today # Today's stats
131134
tmpo stats --week # This week's stats
135+
tmpo stats --date "2026-01-15" # January 15th, 2026 entries
132136
```
133137

134138
## Configuration
@@ -232,14 +236,18 @@ Milestones help you organize time entries into time-boxed periods like sprints,
232236

233237
### `tmpo milestone start [name]`
234238

235-
Start a new milestone for the current project. All new time entries will be automatically tagged with this milestone until you finish it.
239+
Start a new milestone for the current project, or the one specified. All new time entries will be automatically tagged with this milestone until you finish it.
240+
241+
**Options:**
242+
243+
- `--project "name"` / `-p "name"` - Start a milestone for a specific global project
236244

237245
**Examples:**
238246

239247
```bash
240248
tmpo milestone start "Sprint 1"
241249
tmpo milestone start "Release 2.0"
242-
tmpo milestone start "Q1 Planning"
250+
tmpo milestone start "Q1 Planning" --project "GlobalProject"
243251
```
244252

245253
**Notes:**
@@ -250,29 +258,28 @@ tmpo milestone start "Q1 Planning"
250258

251259
### `tmpo milestone finish`
252260

253-
Finish the currently active milestone for the current project. This stops auto-tagging new entries and marks the milestone as completed.
261+
Finish the currently active milestone for the current project, or the one specified. This stops auto-tagging new entries and marks the milestone as completed.
262+
263+
**Options:**
264+
265+
- `--project "name"` / `-p "name"` - Finish a milestone for a specific global project
254266

255267
```bash
256268
tmpo milestone finish
257-
# Output:
258-
# [tmpo] Finished milestone Sprint 1
259-
# Duration: 2w 3d 5h 30m
260-
# Entries: 47
269+
tmpo milestone finish --project "GlobalProject"
261270
```
262271

263272
### `tmpo milestone status`
264273

265274
Show detailed information about the currently active milestone.
266275

276+
**Options:**
277+
278+
- `--project "name"` / `-p "name"` - Show milestone status for a specific global project
279+
267280
```bash
268281
tmpo milestone status
269-
# Output:
270-
# [tmpo] Active Milestone: Sprint 1
271-
# Project: my-project
272-
# Started: Dec 15, 2024 9:00 AM
273-
# Duration: 5d 12h 30m
274-
# Entries: 23
275-
# Total Time: 42h 15m
282+
tmpo milestone status --project "GlobalProject"
276283
```
277284

278285
### `tmpo milestone list`

0 commit comments

Comments
 (0)