Smos Logo Smos

A comprehensive self-management system

Using smos-query

Documentation about the smos-query clock command, for showing where you have spent your time

The clock report shows you an overview of the clocking that you have done for each entry in a nice forest-shaped overview.

Reference

Options

smos-query clock [FILTER [FILTER]] [[--begin DAY] [--end DAY] | --yesterday | --today | --tomorrow | --last-week | --past-week | --this-week | --coming-week | --next-week | --last-month | --past-month | --this-month | --coming-month | --next-month | --last-year | --past-year | --this-year | --coming-year | --next-year | [--all-time]] [--day-block | --week-block | --month-block | --year-block | [--one-block]] [--pretty | --yaml | --json | [--pretty-json]] [--temporal [--seconds | --minutes | [--hours]] | --decimal [--hours | --quarters | [--decimals DIGITS]]] [--forest | [--flat]] [--hide-archive | --show-archive|-a]

  FILTER            A filter to filter entries by                                                          
  FILTER            A filter to filter entries by                                                          
  --begin           start date (inclusive)                                                                 
  --end             end time (inclusive)                                                                   
  --yesterday       yesterday                                                                              
  --today           today                                                                                  
  --tomorrow        tomorrow                                                                               
  --last-week       last week                                                                              
  --past-week       the past week                                                                          
  --this-week       this week                                                                              
  --coming-week     the coming week                                                                        
  --next-week       next week                                                                              
  --last-month      last month                                                                             
  --past-month      the past month                                                                         
  --this-month      this month                                                                             
  --coming-month    the coming month                                                                       
  --next-month      next month                                                                             
  --last-year       last year                                                                              
  --past-year       the past year                                                                          
  --this-year       this year                                                                              
  --coming-year     the coming year                                                                        
  --next-year       next year                                                                              
  --all-time        all time                                                              default: AllTime 
  --day-block       blocks of one day                                                                      
  --week-block      blocks of one week                                                                     
  --month-block     blocks of one month                                                                    
  --year-block      blocks of one year                                                                     
  --one-block       a single block                                                        default: OneBlock
  --pretty          pretty text                                                                            
  --yaml            Yaml                                                                                   
  --json            single-line JSON                                                                       
  --pretty-json     pretty JSON                                                           default: pretty  
  --temporal        Show the clocks with a temporal resolution (hours and minutes)                         
  --seconds         Show clocks in seconds                                                                 
  --minutes         Show clocks in minutes                                                                 
  --hours           Show clocks in hours                                                  default: minutes 
  --decimal         Show the clocks with a decimal resolution (hours and tenths of hours)                  
  --hours           Show clocks in a decimal number of hours                                               
  --quarters        Show clocks in a decimal number of quarter hours                                       
  --decimals        Show clocks in a decimal manner, with this many decimals              default: 2       
  --forest          Show the clocks as a forest                                                            
  --flat            Show the clocks line by line                                          default: forest  
  --hide-archive    Hide archived files                                                                    
  --show-archive|-a Do not hide archived files                                                             

Environment variables

  SMOS_CLOCK_IGNORE_ARCHIVE BOOL   Whether to consider archived entries   default: Don'tHideArchive

Configuration values

  Whether to consider archived entries
  default: Don'tHideArchive
  clock.hide-archive:
    # or null
    <boolean>

Combined settings

Usage: smos-query clock [FILTER [FILTER]] [[--begin DAY] [--end DAY] | --yesterday | --today | --tomorrow | --last-week | --past-week | --this-week | --coming-week | --next-week | --last-month | --past-month | --this-month | --coming-month | --next-month | --last-year | --past-year | --this-year | --coming-year | --next-year | [--all-time]] [--day-block | --week-block | --month-block | --year-block | [--one-block]] [--pretty | --yaml | --json | [--pretty-json]] [--temporal [--seconds | --minutes | [--hours]] | --decimal [--hours | --quarters | [--decimals DIGITS]]] [--forest | [--flat]] [--hide-archive | --show-archive|-a]

Run the clock report

Available settings:
  Show this help text
  switch: -h|--help

  A filter to filter entries by
  argument: FILTER

  A filter to filter entries by
  argument: FILTER

  start date (inclusive)
  option: --begin DAY

  end time (inclusive)
  option: --end DAY

  yesterday
  switch: --yesterday

  today
  switch: --today

  tomorrow
  switch: --tomorrow

  last week
  switch: --last-week

  the past week
  switch: --past-week

  this week
  switch: --this-week

  the coming week
  switch: --coming-week

  next week
  switch: --next-week

  last month
  switch: --last-month

  the past month
  switch: --past-month

  this month
  switch: --this-month

  the coming month
  switch: --coming-month

  next month
  switch: --next-month

  last year
  switch: --last-year

  the past year
  switch: --past-year

  this year
  switch: --this-year

  the coming year
  switch: --coming-year

  next year
  switch: --next-year

  all time
  switch: --all-time
  default: AllTime

  blocks of one day
  switch: --day-block

  blocks of one week
  switch: --week-block

  blocks of one month
  switch: --month-block

  blocks of one year
  switch: --year-block

  a single block
  switch: --one-block
  default: OneBlock

  pretty text
  switch: --pretty

  Yaml
  switch: --yaml

  single-line JSON
  switch: --json

  pretty JSON
  switch: --pretty-json
  default: pretty

  Show the clocks with a temporal resolution (hours and minutes)
  switch: --temporal

  Show clocks in seconds
  switch: --seconds

  Show clocks in minutes
  switch: --minutes

  Show clocks in hours
  switch: --hours
  default: minutes

  Show the clocks with a decimal resolution (hours and tenths of hours)
  switch: --decimal

  Show clocks in a decimal number of hours
  switch: --hours

  Show clocks in a decimal number of quarter hours
  switch: --quarters

  Show clocks in a decimal manner, with this many decimals
  option: --decimals DIGITS
  default: 2

  Show the clocks as a forest
  switch: --forest

  Show the clocks line by line
  switch: --flat
  default: forest

  Hide archived files
  switch: --hide-archive

  Do not hide archived files
  switch: --show-archive|-a

  Whether to consider archived entries
  env: SMOS_CLOCK_IGNORE_ARCHIVE BOOL
  config:
    clock.hide-archive: # or null
      <boolean>
  default: Don'tHideArchive