st

2014-03-04

st is a command line application that enables adding time data from the command line, and listing projects and buckets from the command line.

If using a desktop computer, or laptop computer, one can run STOPTHAT GUI. The GUI enables adding time data, listing projects, listing buckets. But some devices may only have the command line. st brings some of the functions to the command line.

st is a short form of “stop that”. It has two subcommands, add and list.

Help text for st:

$ st --help usage: st [-h] {add,list} ... CLI app for adding to STOPTHAT database positional arguments: {add,list} Choose between adding a line and listing configured projects. add Add line to STOPTHAT database. list List configured projects. optional arguments: -h, --help show this help message and exit For this to work, STOPTHAT needs to be fully configured.

Add Time Date

The main thing you would do with st is add time data from the command line. Use st add for this purpose. Example:

$ st add KSPL "Add a page to the website."

This would add a datum right now, to project with ID KSPL, saying I just finished the task of adding a page to the website.

You can also enter a date override to enter data for some time other than right now. Example:

$ st add -d " -:15" MISC "Check email."

This would add a datum saying that fifteen minutes ago I finished checking email, and assign that time to the MISC project.

Help text for st add:

$ st add --help usage: st add [-h] [-d DATE] projectid description positional arguments: projectid Project ID of the data you are adding. description Description of the data you are adding. optional arguments: -h, --help show this help message and exit -d DATE, --date DATE Use the following date rather than now. Can be relative.

List Projects

When you are adding time data from the command line, you may need to be reminded about what project IDs you have configured. Use st list for this purpose. Example:

$ st list -b mybucket

This would list all projects in the bucket “mybucket”.

You may even need a reminder about what buckets you have configured. st list can also list the buckets, like this:

$ st list -np

Help text for st list:

$ st list --help usage: st list [-h] [-b BUCKETS [BUCKETS ...]] [-o] [-np] optional arguments: -h, --help show this help message and exit -b BUCKETS [BUCKETS ...], --buckets BUCKETS [BUCKETS ...] Include only these buckets when listing projects. -o, --old Show archived projects rather than current ones. -np, --noprojects Omit projects, showing just the bucket names.

16417.69163