enhance description in the docs
This commit is contained in:
Abraham Toriz
parent
61f80f2be6
commit
5e4fd1cb37
|
|
@ -18,39 +18,40 @@ Subcommands
|
|||
+-----------+-------+----------------------------------------------------------+
|
||||
| Command | Alias | Description |
|
||||
+===========+=======+==========================================================+
|
||||
| archive | a | Archive entries to a hidden sheet so they are out of the |
|
||||
| | | way |
|
||||
| archive | a | Archive entries to a hidden timesheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| backend | b | Open an sqlite shell to the database. |
|
||||
| backend | b | Open an sqlite shell to the database (requires having |
|
||||
| | | sqlite3 installed. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| configure | c | Configure tiempo in-place or get path to config file |
|
||||
| configure | c | Configure tiempo in-place or get path to config file. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| display | d | Display all entries in the current sheet |
|
||||
| display | d | Display all entries in the current sheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| edit | e | Edit an entry |
|
||||
| edit | e | Edit an entry. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| in | i | Start an activity in the current timesheet |
|
||||
| in | i | Start an entry in the current timesheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| kill | k | Delete an entry or an entire sheet |
|
||||
| kill | k | Delete an entry or an entire timesheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| list | l | List existing sheets |
|
||||
| list | l | List existing sheets. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| month | m | Display entries starting this month |
|
||||
| month | m | Display entries starting this month. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| now | n | Show all running entries |
|
||||
| now | n | Show all running entries. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| out | o | end the active entry in the current timesheet |
|
||||
| out | o | End the active entry in the current timesheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| resume | r | Restart the timer for an entry. Defaults to the last |
|
||||
| | | active entry |
|
||||
| | | active entry. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| sheet | s | Change active timesheet or list existing timesheets |
|
||||
| sheet | s | Switch to a new or existing timesheet. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| today | t | Display entries that started today |
|
||||
| today | t | Display entries that started today. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| week | w | Display entries starting last monday or later |
|
||||
| week | w | Display entries starting last monday or later (First day |
|
||||
| | | of the week configurable). |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
| yesterday | y | Display entries that started yesterday |
|
||||
| yesterday | y | Display entries that started yesterday. |
|
||||
+-----------+-------+----------------------------------------------------------+
|
||||
|
||||
Description
|
||||
|
|
@ -60,8 +61,24 @@ Tiempo is a command-line time tracker. Register the start and end times of your
|
|||
activities and get results by day, week, month or custom periods of time in
|
||||
different formats, including custom ones.
|
||||
|
||||
You can also group your entries by 'sheet' to organize different
|
||||
projects/clients/etc.
|
||||
Entries are optionally organized in timesheets which you can use to represent
|
||||
projects, clients etc. Most commands (notably the ones that display entries)
|
||||
work on the *current* or *active* timesheet.
|
||||
|
||||
The entries are stored in a local Sqlite3 database whose location you can learn
|
||||
by looking at your config file (whose location you can learn running ``t c``).
|
||||
|
||||
**tiempo** stores entries as UTC and then converts to the local timezone for
|
||||
displaying and querying. This means that even if you change timezones your
|
||||
recorded times will be correct, although their displayed results might vary if
|
||||
grouping by day for example.
|
||||
|
||||
This tool is compatible with a previous one with the same purpose called
|
||||
``timetrap``. The most notable difference being that timetrap stores times as
|
||||
local timezone times, which makes it messy if you switch timezones. Another
|
||||
difference is that in timetrap you used the internal ruby API to add custom
|
||||
display formats and in ``tiempo`` you'll use standard input/output and
|
||||
command-line arguments in any language of your choice.
|
||||
|
||||
Tutorial
|
||||
--------
|
||||
|
|
@ -99,10 +116,10 @@ Per command default formatters
|
|||
**New in 1.4.0**
|
||||
|
||||
It might be the case that you want to use one default formatter for when you use
|
||||
``t week`` and a different one for ``t month`` or ``t today``. That's what per-command
|
||||
default formatters are for. To use them just add a ``commands`` section to your
|
||||
config file and set ``default_formatter`` on some formatters. This is what it
|
||||
would look like:
|
||||
``t week`` and a different one for ``t month`` or ``t today``. That's what
|
||||
per-command default formatters are for. To use them just add a ``commands``
|
||||
section to your config file and set ``default_formatter`` on some formatters.
|
||||
This is what it would look like:
|
||||
|
||||
**In toml**
|
||||
|
||||
|
|
@ -134,8 +151,8 @@ Files and paths
|
|||
Specifying times
|
||||
----------------
|
||||
|
||||
Some arguments accept a time as value, like ``t in``'s ``--at`` or ``t d --start``.
|
||||
These are the accepted formats:
|
||||
Some arguments accept a time as value, like ``t in``'s ``--at`` or ``t d
|
||||
--start``. These are the accepted formats:
|
||||
|
||||
**Something similar to ISO format** will be parsed as a time in the computer's
|
||||
timezone.
|
||||
|
|
@ -191,9 +208,9 @@ chart
|
|||
**Settings**
|
||||
|
||||
By default this formatter will only display a nice chart of the progress divided
|
||||
by week and respecting the ``week_start`` setting. However you may specify a daily
|
||||
goal and a weekly goal to customize the chart, as well as how many minutes each
|
||||
character represents:
|
||||
by week and respecting the ``week_start`` setting. However you may specify a
|
||||
daily goal and a weekly goal to customize the chart, as well as how many minutes
|
||||
each character represents:
|
||||
|
||||
In toml:
|
||||
|
||||
|
|
@ -297,14 +314,14 @@ Custom formatters
|
|||
-----------------
|
||||
|
||||
You can implement your own formatters for all subcommands that display entries
|
||||
(like ``t display``, ``t week`` etc.). It is as easy as creating an executable file
|
||||
written in any programming language (interpreted or compiled) and placing it in
|
||||
a path listed in the config value for ``formatter_search_paths``.
|
||||
(like ``t display``, ``t week`` etc.). It is as easy as creating an executable
|
||||
file written in any programming language (interpreted or compiled) and placing
|
||||
it in a path listed in the config value for ``formatter_search_paths``.
|
||||
|
||||
This executable will be given as standard input a csv stream with each row
|
||||
representing a time entry with the same structure as the ``csv`` formatter output.
|
||||
It will also be given a command line argument representing user settings for
|
||||
this formatter stored in the config file and formatted as JSON.
|
||||
representing a time entry with the same structure as the ``csv`` formatter
|
||||
output. It will also be given a command line argument representing user settings
|
||||
for this formatter stored in the config file and formatted as JSON.
|
||||
|
||||
Example
|
||||
.......
|
||||
|
|
|
|||
Loading…
Reference in New Issue