Skip to content

Commit 15340ea

Browse files
committed
Add details and colors to website and readme
1 parent 8ea9055 commit 15340ea

File tree

12 files changed

+113
-838
lines changed

12 files changed

+113
-838
lines changed

README.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,34 @@
1818
·
1919
<a href="https://github.com/lcfd/trak/issues">Issues</a>
2020
</p>
21-
</p>
21+
</p>
22+
23+
## Installation
24+
25+
## Usage
26+
27+
```bash
28+
trak start <project-name>
29+
trak stop
30+
trak status
31+
trak report
32+
```
33+
34+
Start trakking a project that is billable:
35+
36+
`trak start pasta -b`
37+
38+
Start tracking a project on a specific category/topic:
39+
40+
`trak start pasta -c rigatoni`
41+
42+
## Starship
43+
44+
`trak status -s`
45+
46+
```bash
47+
[custom.timetrace]
48+
command = """ trak status --s """
49+
when = "trak status"
50+
shell = "sh"
51+
```

assets/logo.svg

+10
Loading

cli/src/trak/cli.py

+9-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,15 @@ def stop_tracker():
172172

173173

174174
@app.command()
175-
def status():
175+
def status(starship: Annotated[
176+
bool,
177+
typer.Option(
178+
"--starship",
179+
"-s",
180+
help="Show the output formatted for Starship.",
181+
show_default=True,
182+
),
183+
] = False,):
176184
"""
177185
Show the status of the current session.
178186
"""

0 commit comments

Comments
 (0)