Usage

At its core, Chrono is a very simple tool. All you need to do to get started with tracking your time is to use the start command.

The basic syntax of the start command is:

$ chrono start [project] [tags] [flags]

Tags are an easy way to categories your projects. For example, tagging work related projects with +work and personal projects with +personal.

Tags must begin with a plus sign to be considered valid

If you wanted to start tracking time for a project called "hello-world" with a tag of "work" you would do the following

$ chrono start hello-world +work

Now the timer is running and you can make some progress on your hello-world project!

As you do, you can add notes to help you remember what you did later on.

Let's add a note describing some work we did on the "hello-world" project

$ chrono notes add "changed the output to goodbye world"

Next we'll stop the timer for our hello-world project:

$ chrono stop

If you need to stop the current project but don't want to save it, use the cancel command:

$ chrono cancel

The time spent on the project is stored in a frame. A frame is a timespan (contains a start and end time) along with some information about that timespan (name, notes, tags, etc).

Another important command is the log command. This will show you all of the frames for a specific time period. By default it shows only the frames for the current day.

$ chrono log

You can use the --week, --month, and --year flags to show all the frames for the current week, month, and year respectively.

The log command will also show any notes for those frames.

If you wanted to get a list of all the tags you've ever used, you can use the tags command:

$ chrono tags

Alternatively, if you wanted to get a list of all project names you would use the projects command

$ chrono projects

If you want to restart a previously stopped project, you can use the restart command:

It's syntax is:

$ chrono resart [frame]

Where [frame] is an optional argument of a frame UUID or index. If none is given, then the default is to use the last added frame.

If you want to view all frame ID's, you can use the frames command.

You can pass in the --describe flag to the frames command to see more information about the frames.

If you need to remove a frame, you can use the remove command.

Its syntax is:

$ chrono remove [frame]

Where [frame] is a frame ID or index position.