Skip to content

Latest commit

 

History

History
215 lines (156 loc) · 4.34 KB

configuration.md

File metadata and controls

215 lines (156 loc) · 4.34 KB

Configuration

Location

Data is stored in JSON format in $XDG_CONFIG_HOME/tod.cfg. This defaults to:

  • ~/.config/tod.cfg on Linux
  • ~/Library/Application Support/tod.cfg on Mac
  • No idea about Windows, sorry!

Values

bell_on_success

  type: boolean
  default: false

Triggers the terminal bell on successful completion of a command

bell_on_failure

  type: boolean
  default: true

Triggers the terminal bell on an error

disable_links

  type: boolean
  default: false

If true, disables OSC8 linking and just displays plain text

last_version_check

  type: nullable string
  default: null
  possible_values: any string in format YYYY-MM-DD

Holds a string date, i.e. "2023-08-30" representing the last time crates.io was checked for the latest tod version. Tod will check crates.io a maximum of once per day.

max_comment_length

  type: nullable positive integer
  default: null
  possible_values: Any positive integer or null

The maximum number of characters that will be printed in total when showing comments.

next_id

  type: nullable string
  default: null
  possible values: null or any positive integer in string form

When task next is executed the ID is stored in this field. When task complete is run the field is set back to null

path

  type: string
  default: $XDG_CONFIG_HOME/tod.cfg
  possible values: Any path

Location of the tod configuration file

natural_language_only

  type: nullable boolean
  default: null
  possible values: null, true, or false

If true, the datetime selection in project schedule will go straight to natural language input.

no_sections

  type: nullable boolean
  default: null
  possible values: null, true, or false

If true will not prompt for a section whenever possible

sort_value

Tasks are ranked by points and the first is returned, the points are the sum of the following:

  • Task is overdue: 150
  • The date is today with no time: 100
  • The date is today with time in next or last 15 min: 200
  • No date: 80
  • Not recurring: 50
  • Task has no priority: 2
  • Priority 1: 1
  • Priority 2: 3
  • Priority 3: 4

Defaults:

  {
    "no_due_date": 80,
    "not_recurring": 50,
    "now": 200,
    "overdue": 150,
    "priority_high": 4,
    "priority_low": 1,
    "priority_medium": 3,
    "priority_none": 2,
    "today": 100
  },

spinners

  type: nullable boolean
  default: null
  possible values: null, true, or false

Controls whether the spinner is displayed when an API call occurs. Useful for cases where the terminal output is captured. null is considered the same as true.

You can also use the environment variable DISABLE_SPINNER to turn them off.

  DISABLE_SPINNER=1 tod task create

timeout

  type: integer
  default: 30 (seconds)
  possible values: Any positive number in seconds

timezone

  type: string
  default: No default
  possible values: Any timezone string i.e. "Canada/Pacific"

You will be prompted for timezone on first run

token

  type: string
  default: No default
  possible values: Any valid token

You will be prompted for your Todoist API token on first run

vecprojects

  type: Nullable array of objects
  default: null
  possible values: List of project objects from the Todoist API

Projects are stored locally in config to help save on API requests and speed up actions taken. Manage this with the project subcommands. The strange naming is because projects was used in previous versions of tod.

verbose

  type: nullable boolean
  default: null
  possible values: null, true, or false

Outputs additional information in console to assist with debugging.