clockify-cli config

clockify-cli config

Manages CLI configuration

Synopsis

Changes or shows configuration settings for clockify-cli

These are the parameters manageable:

  • allow-archived-tags: should allow and suggest archived tags
  • allow-incomplete: should allow starting time entries with missing required values
  • allow-name-for-id: allow to input the name of the entity instead of its ID (projects, clients, tasks, users and tags)
  • description-autocomplete: autocomplete description looking at recent time entries
  • description-autocomplete-days: how many days should be considered for the description autocomplete
  • interactive: show interactive mode
  • log-level: how much logs should be shown values: none , error , info and debug
  • show-task: should show an extra column with the task description
  • show-total-duration: adds a totals line on time entry reports with the sum of the time entries duration
  • token: clockify’s token
  • user.id: user id from the token
  • workspace: workspace to be used
  • workweek-days: days of the week were your expected to work (use comma to set multiple)

Examples

# cli will guide you to configure the CLI
$ clockify-cli config init

# token is the minimum information required for the CLI to work
$ clockify-cli set token <token>

# you can see your current parameters using:
$ clockify-cli get

# if you wanna see the value of token parameter:
$ clockify-cli get token

Options

  -h, --help   help for config

Options inherited from parent commands

      --allow-name-for-id           allow use of project/client/tag's name when id is asked
  -i, --interactive                 will prompt you to confirm/complement commands input before executing the action 
  -L, --interactive-page-size int   will set how many items will be shown on interactive mode (default 7)
      --log-level string            { none | debug | info } set log level (default "none")
  -t, --token string                clockify's token
                                    Can be generated here: https://clockify.me/user/settings#generateApiKeyBtn
  -u, --user-id string              user id from the token
  -w, --workspace string            workspace to be used

SEE ALSO

Auto generated by spf13/cobra on 29-Mar-2024