Skip to content

avilabss/ticktick-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ticktick-cli

CLI tool for interacting with the TickTick API.

Installation

From GitHub Releases

Download the latest binary for your platform from the releases page.

macOS (Apple Silicon)

curl -L -o tick https://github.com/avilabss/ticktick-cli/releases/latest/download/tick-darwin-arm64
chmod +x tick
sudo mv tick /usr/local/bin/

macOS (Intel)

curl -L -o tick https://github.com/avilabss/ticktick-cli/releases/latest/download/tick-darwin-amd64
chmod +x tick
sudo mv tick /usr/local/bin/

Linux (x86_64)

curl -L -o tick https://github.com/avilabss/ticktick-cli/releases/latest/download/tick-linux-amd64
chmod +x tick
sudo mv tick /usr/local/bin/

Linux (ARM64)

curl -L -o tick https://github.com/avilabss/ticktick-cli/releases/latest/download/tick-linux-arm64
chmod +x tick
sudo mv tick /usr/local/bin/

Windows

Download tick-windows-amd64.exe from the releases page, rename to tick.exe, and add its location to your PATH.

From source

go install github.com/avilabss/ticktick-cli/cmd/tick@latest

Verify

tick --help

Setup

  1. Log in to ticktick.com in your browser
  2. Open DevTools (F12 or Cmd+Option+I)
  3. Go to ApplicationCookieshttps://ticktick.com
  4. Copy the value of the cookie named t
  5. Create a .env file in the directory where you run tick:
TICKTICK_API_TOKEN=paste_cookie_value_here

Usage

tick <command> <subcommand> [flags]

Commands

Tasks

tick task list [--project NAME] [--tag TAG] [--priority N]
tick task add --title "..." [--project NAME] [--tags "a,b"] [--priority N] [--due DATE]
tick task complete ID [--project NAME]
tick task delete ID [--project NAME]
tick task get ID [--project NAME]
tick project list

Pomodoro

tick pomodoro export [--year N] [--month N] [--output FILE] [--include-tags ...] [--exclude-tags ...]
tick pomodoro stats
tick pomodoro create [--task ID] [--duration MINS]
tick pomodoro delete ID
tick pomodoro timer list
tick pomodoro timer stats NAME

Habits

tick habit list
tick habit checkin HABIT_NAME [--value N]
tick habit status [--date YYYY-MM-DD]

Help

Every command supports --help:

tick --help
tick task --help
tick task add --help

Global Flags

tick -v ...     # Info level logging
tick -vv ...    # Debug level logging
tick -vvv ...   # Trace level logging

Development

Testing

just test                # unit tests
just test-v              # unit tests (verbose)
just test-integration    # integration tests (requires .env)

Linting

just lint

All Justfile commands

just --list

Releasing

Every push to main automatically:

  1. Runs tests
  2. Increments the patch version (e.g. v0.0.1 → v0.0.2)
  3. Builds binaries for all platforms (linux/darwin/windows, amd64/arm64)
  4. Publishes a GitHub release with SHA256 checksums

To bump minor or major version, create the tag manually before the next push:

git tag v0.1.0
git push origin v0.1.0

The next auto-release will increment from that tag (v0.1.0 → v0.1.1).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors