Skip to content

Commit 89cfe02

Browse files
committed
Update CLI commands in README [ci skip]
1 parent 18309a0 commit 89cfe02

1 file changed

Lines changed: 35 additions & 21 deletions

File tree

README.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -145,27 +145,41 @@ Here's a list of all the commands available for GTM.
145145
usage: gtm [--version] [--help] <command> [<args>]
146146
147147
Available commands are:
148-
commit
149-
Usage: gtm commit [-yes]
150-
Save your logged time with the last commit
151-
This is automatically called from the postcommit hook
152-
Warning - any time logged will be cleared from your working directory
153-
154-
init
155-
Usage: gtm init
156-
Initialize a git project for time tracking
157-
158-
record
159-
Usage: gtm record <filepath>
160-
Record a file event
161-
162-
report
163-
Usage: gtm report [-n] [-format commits|totals|files|timeline] [-total-only] <commit-sha1...>
164-
Report on time logged
165-
166-
status
167-
Usage: gtm status [-total-only]
168-
Show time spent for working or staged files
148+
clean
149+
Usage: gtm clean [-yes]
150+
Cleans uncommitted time data by removing all event and metric files from the .gtm directory
151+
152+
commit
153+
Usage: gtm commit [-yes]
154+
Save your logged time with the last commit
155+
This is automatically called from the postcommit hook
156+
Warning - any time logged will be cleared from your working directory
157+
158+
init
159+
Usage: gtm init
160+
Initialize a git project for time tracking
161+
162+
record
163+
Usage: gtm record [-status] <path/file>
164+
Record a file event
165+
166+
report
167+
Usage: gtm report [-n] [-format commits|totals|files|timeline] [-total-only]
168+
Report on time logged
169+
170+
status
171+
Usage: gtm status [-total-only]
172+
Show time spent for working or staged files
173+
174+
uninit
175+
Usage: gtm uninit [-yes]
176+
Remove GTM tracking for the current git repository
177+
Note - this removes uncommitted time data but does not remove time data that is committed
178+
179+
verify
180+
Usage: gtm verify <version constraint>
181+
Verify gtm satisfies the version constraint
182+
This is typically invoked by plug-ins to determine if GTM needs to be upgraded
169183
```
170184

171185
For general help `gtm --help` and for help on a command `gtm --help <command>`

0 commit comments

Comments
 (0)