Skip to content

Latest commit

 

History

History
311 lines (215 loc) · 12.1 KB

guide.md

File metadata and controls

311 lines (215 loc) · 12.1 KB
Raw

Usage Guide

Default Extension Trigger

tgl - Adjust as needed in Ulauncher preferences.

Arguments

Argument Description Symbol Examples
Name Description/Name of a model enclosed in double quotes.1 "..." "Time Tracker"
Project ID or name of a project. If the name contains spaces include quotes. @ @3512351
Start Start time of a tracker, project or report.2 > >10:10
Stop End time of a tracker or project.2 < <10:20
Duration Duration of the tracker. Supports hours, minutes, seconds, weeks, days. >...< >1h<, >1m<, >1w<, >1d<
Tags Comma separated list of tags starting with a pound sign. If specifically removing tags it must be prefixed with a minus - sign. Can also be prefixed with a plus +, but will default to adding tags anyway. 1 #... #-tag1,tag2,tag3
Color Hex code of color. If using non-premium only the supplied colors will work. #... #ffffff
Refresh While directly fetch from the Toggl API if this is enabled. Most of the commands support this. refresh refresh
Client ID or name of a client. . If the name contains spaces include quotes. 1 $ $3521315
Misc. Flags Inverted boolean flags, so if set the will return as False. Distinct will generally filter out duplicate tracker entries if turned on and is on by default in some tracker commands. distinct private, active, distinct
Path File path to a folder for exporting reports start with a tilde. 3 4 ~ ~/reports
Report Format File format to save a report in. . .csv or .pdf
ID General identifier if targeting a specific model. Can be a name or the numerical id starting. If the name contains spaces include quotes. Also used in order to search with fuzzy matching. : :"Random Tracker"
Sort Order Sorting direction for listing models. Default to descending. Most commands that list models support this argument. ^- ^-

1 Autocomplete is supplied.

2 Supported formats are: YYYY-MM-DDTHH:MM:SS, HH:MM, HH:MM:SS, YYYY-MM-DD plus the 12 hour equivalents with AM/PM added e.g. >10:10 PM. If just using time the date will default to the current date.

3 Filename will default to current date and scope of report.:MM:SS, YYYY-MM-DD plus the 12 hour equivalents with AM/PM added e.g. >10:10 PM. If just using time the date will default to the current date.

4 Folder structure will be created if not present.

Commands

Continue

  • Description: Continue the last tracker or a tracker selected from the provided list.
  • Usage: tgl continue
  • Alt-Option: List alternative trackers to continue from cache.
  • Aliases: continue, cnt, cont, restart
  • Optional Arguments: Start, ID, Distinct,

Start

  • Description: Start a new tracker. 1
  • Usage: tgl start "Example Tracker" >11:42 #example-tag
  • Alt-Option: List trackers a pre-fill options to be edited before starting.
  • Aliases: start, stt, begin
  • Required Arguments: Description
  • Optional Arguments: Project, Start, Tags, Distinct

Stop

  • Description: Stop the current tracker.
  • Usage: tgl stop
  • Aliases: stop, end, stp
  • Optional Arguments: Stop

Edit

  • Description: Edit the current trackers attributes. 1
  • Usage: tgl edit "Example Tracker Edit" >11:50 <15:00
  • Aliases: edit, change, amend, ed
  • Optional Arguments: Description, Project, Start, Tags, Stop, Distinct,

Add

  • Description: Add a new tracker with given attributes. 1
  • Usage: tgl add "Example Tracker" >11:42 <12:00
  • Alt-Option: Select a tracker from cache to be used as a pre-fill option.
  • Aliases: add, insert, create
  • Required Arguments: Start, Stop, Description
  • Optional Arguments: Duration, Project, Tags, Distinct,

Delete

  • Description: Delete the selected tracker selected from a provided list.
  • Usage: tgl delete
  • Aliases: delete, remove, del, rm
  • Optional Arguments: Distinct, ID,

List

  • Description: Display a list of trackers. Use one of the listed trackers for more options and details.
  • Usage: tgl list refresh
  • Alt-Option: Refresh cache and fetch new trackers.
  • Aliases: list, ls, lst
  • Optional Arguments: Distinct, ID,

Current

  • Description: Display the current tracker.
  • Usage: tgl current
  • Aliases: current, now, running

Refresh 5

  • Description: Refresh a single tracker.
  • Usage: tgl refresh
  • Aliases: refresh, re, update
  • Optional Arguments: Distinct, ID

Projects

  • Description: Display a list of subcommands related to projects.
  • Usage: tgl project
  • Aliases: projects, proj, project

Subcommands:

List
  • Description: Display a list of projects. Select a project for more options/details.
  • Usage: tgl project list
  • Alt-Option: Refresh cache and fetch new projects.
  • Aliases: list, ls, lst
  • Optional Arguments: Active, ID
Add
  • Description: Add a new project. 2
  • Usage: tgl project add "Example Project" #0b83d9
  • Alt-Option: Use a list of projects as pre-fill options.
  • Aliases: add, create, insert
  • Required Arguments: Description
  • Optional Arguments: Color, Client, Active, Private
Edit
  • Description: Edit an existing project. 2
  • Usage: tgl project edit "Example Project Edit"
  • Aliases: edit, ed, change, amend
  • Optional Arguments: Description, Color, Client, Active, Private
Delete
  • Description: Delete a project. Provides a list of projects to select from.
  • Usage: tgl project delete
  • Aliases: delete, rm, remove, del
  • Optional Arguments: ID
Refresh 5
  • Description: Refresh a single project model.
  • Usage: tgl project refresh
  • Aliases: refresh, re, update
  • Optional Arguments: ID

Clients

  • Description: Display a list of subcommands related to clients.
  • Usage: tgl client
  • Aliases: client, cli, clients

Subcommands:

List
  • Description: Display a list of clients. Select a client for more options/details.
  • Usage: tgl client list
  • Alt-Option: Refresh cache and fetch new clients.
  • Aliases: list, ls, lst
  • Optional Arguments: ID
Add
  • Description: Add a new client. 3
  • Usage: tgl client add "Example Client"
  • Alt-Option: Use a list of clients as pre-fill options.
  • Aliases: add, create, insert
  • Required Arguments: Description
Edit
  • Description: Edit an existing client. 3
  • Usage: tgl client edit "Example Client Edit"
  • Aliases: edit, ed, change, amend
  • Optional Arguments: Description, ID
Delete
  • Description: Delete a client. Provides a list of clients to select from.
  • Usage: tgl client delete
  • Aliases: delete, rm, del, remove
  • Optional Arguments: ID
Refresh 5
  • Description: Refresh a single client model.
  • Usage: tgl client refresh
  • Aliases: refresh, re, update
  • Optional Arguments: ID

Tags

  • Description: Display a list of subcommands related to tags.
  • Usage: tgl tag
  • Aliases: tag, tags

Subcommands:

List
  • Description: Display a list of tags. Select a tag for more options/details.
  • Usage: tgl tag list
  • Alt-Option: Refresh cache and fetch new tags.
  • Aliases: list, ls, lst
  • Optional Arguments: ID
Add
  • Description: Add a new tag. 4
  • Usage: tgl tag add "New Tag"
  • Alt-Option: Use a list of tags as pre-fill options.
  • Aliases: add, create, insert
  • Required Arguments: Description
Edit
  • Description: Edit an existing tag. 4
  • Usage: tgl tag edit "Edited Tag"
  • Aliases: edit, amend, ed, change
  • Optional Arguments: Description, ID
Delete
  • Description: Delete a tag. Provides a list of tags to select from.
  • Usage: tgl tag delete
  • Aliases: delete, rm, del, remove
  • Optional Arguments: ID

Reports

  • Description: Export & view reports on a daily, weekly or monthly basis.
  • Usage: tgl report
  • Aliases: report, stats, rep, statistics

Subcommands:

Day
  • Description: View daily tracked stats and export a pdf or csv report.
  • Usage: tgl report day
  • Alt-Option: Directly export a daily report.
  • Aliases: day, daily
  • Optional Arguments: Start, Path, Report Format
Week
  • Description: View weekly tracked stats and export a pdf or csv report.
  • Usage: tgl report week
  • Alt-Option: Directly export a weekly report.
  • Aliases: week, weekly
  • Optional Arguments: Start, Path, Report Format
Month
  • Description: View monthly tracked stats and export a pdf or csv report.
  • Usage: tgl report month
  • Alt-Option: Directly export a monthly report.
  • Aliases: month, monthly
  • Optional Arguments: Start, Path, Report Format

Help

  • Description: Find out more about extensions commands.
  • Usage: tgl help <command>
  • Aliases: help, guide, hint

Notes

  • Alt-Option refers to hovering a command and triggering it with alt + enter

1 Will provide a list of older trackers as pre fill options. These commands have a distinct flag available.

2 Will provide a list of older projects as pre fill options.

3 Will provide a list of older clients as pre fill options.

4 Will provide a list of older tags as pre fill options.

5 Will not appear unless a direct match.