Skip to content

Latest commit

 

History

History
325 lines (223 loc) · 6.46 KB

README.md

File metadata and controls

325 lines (223 loc) · 6.46 KB
Raw

track - A Toggl Track personal CLI

oclif codecov tests GitHub license

Usage

$ npm install -g @ulisesantana/track
$ track COMMAND
running command...
$ track (--version)
@ulisesantana/track/1.0.7 darwin-arm64 node-v20.6.0
$ track --help [COMMAND]
USAGE
  $ track COMMAND
...

Commands

track autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ track autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ track autocomplete

  $ track autocomplete bash

  $ track autocomplete zsh

  $ track autocomplete powershell

  $ track autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

track config

Get your config for track.

USAGE
  $ track config

DESCRIPTION
  Get your config for track.

EXAMPLES
  $ track config

See code: src/commands/config.ts

track continue

Continue with last time entry.

USAGE
  $ track continue

DESCRIPTION
  Continue with last time entry.

EXAMPLES
  $ track continue

See code: src/commands/continue.ts

track current

Show running time entry.

USAGE
  $ track current

DESCRIPTION
  Show running time entry.

EXAMPLES
  $ track current

See code: src/commands/current.ts

track help [COMMANDS]

Display help for track.

USAGE
  $ track help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for track.

See code: @oclif/plugin-help

track set description

Set your default time entry description for track.

USAGE
  $ track set description

DESCRIPTION
  Set your default time entry description for track.

EXAMPLES
  $ track set description

See code: src/commands/set/description.ts

track set project

Setup your default project for track.

USAGE
  $ track set project

DESCRIPTION
  Setup your default project for track.

EXAMPLES
  $ track set project

See code: src/commands/set/project.ts

track set token

Setup your Toggl Track API token for track.

USAGE
  $ track set token

DESCRIPTION
  Setup your Toggl Track API token for track.

EXAMPLES
  $ track set token

See code: src/commands/set/token.ts

track set workspace

Setup your default workspace for track.

USAGE
  $ track set workspace

DESCRIPTION
  Setup your default workspace for track.

EXAMPLES
  $ track set workspace

See code: src/commands/set/workspace.ts

track setup

Setup your config for track.

USAGE
  $ track setup

DESCRIPTION
  Setup your config for track.

EXAMPLES
  $ track setup

See code: src/commands/setup.ts

track start [DESCRIPTION]

Start a new time entry.

USAGE
  $ track start [DESCRIPTION] [-i] [-p <value>]

ARGUMENTS
  DESCRIPTION  Time entry description.

FLAGS
  -i, --interactive      Create time entry interactively
  -p, --project=<value>  Project ID or Project name

DESCRIPTION
  Start a new time entry.

EXAMPLES
  $ track start -i

  $ track start Working -p "Your project"

See code: src/commands/start.ts

track stop

Stop running time entry.

USAGE
  $ track stop

DESCRIPTION
  Stop running time entry.

EXAMPLES
  $ track stop

See code: src/commands/stop.ts

track today

Show time entries run today.

USAGE
  $ track today

DESCRIPTION
  Show time entries run today.

EXAMPLES
  $ track today

See code: src/commands/today.ts

track week

Show time entries run current week.

USAGE
  $ track week

DESCRIPTION
  Show time entries run current week.

EXAMPLES
  $ track week

See code: src/commands/week.ts

track yesterday

Show time entries run yesterday.

USAGE
  $ track yesterday

DESCRIPTION
  Show time entries run yesterday.

EXAMPLES
  $ track yesterday

See code: src/commands/yesterday.ts