tickli

Tickli

A command line interface for TickTick task management.

Features

• Smart views: today, tomorrow, next 7 days, inbox, and all tasks across all projects
• Create, update, move, complete, uncomplete, and delete tasks
• Create, update, show, and delete projects; set active project with project use
• Natural language date parsing (e.g. "tomorrow at 2pm", "next Friday")
• Set dates, priorities, tags, and content on tasks
• All-day task support with automatic time stripping
• Filter tasks by priority, tags, and due date window
• Interactive fuzzy-search selection for tasks and projects (auto-disabled when piped)
• Three-tier output: human-readable, JSON, and quiet (IDs only) for scripting
• Global --json and --quiet flags override per-command -o for wrapper scripts
• Single-task commands auto-search all projects — no --project flag needed
• Semantic exit codes (0–4) for reliable programmatic error handling
• Shell completions for Bash, Zsh, and Fish (commands, flags, project/task IDs)
• Respects NO_COLOR environment variable and --no-color flag
• Secure OAuth authentication with XDG-compliant config/token storage

Installation

go install github.com/botre/tickli@latest

This installs the latest tagged version. If no tags exist, it falls back to the tip of the default branch.

Quick Start

1. Create a TickTick App

1. Go to the TickTick Developer Portal
2. Create a new app
3. Set the OAuth redirect URL to http://localhost:8080
4. Note your Client ID and Client Secret

2. Set Up and Use

# Initialize and authenticate with TickTick
tickli init

# List available projects
tickli project list

# Switch to a project (interactive selector)
tickli project use

# Switch to a project by ID
tickli project use abc123def456

# Create a task
tickli task create --title "Finish documentation"

# Create a high priority task with a due date
tickli task create --title "Important meeting" --priority high --date "tomorrow at 2pm"

# List your tasks
tickli task list

# See what's due today (across all projects)
tickli today

# Complete a task
tickli task complete <task-id>

# Uncomplete a task
tickli task uncomplete <task-id>

Commands

General

Smart Views

Smart view flags:

Tasks

Single-task commands (show, update, delete, complete, uncomplete, move) only need a task ID — they search all projects automatically. The --project/-P flag is only needed for list and create.

Task Flags

Projects

Project Flags

Global Flags

Scripting

Tickli is designed to work well in scripts and with other tools:

# Create a task and capture its ID
TASK_ID=$(tickli task create --title "Review PR" --quiet)

# Complete it
tickli task complete "$TASK_ID"

# List task IDs for a project
tickli task list --quiet

# Get task details as JSON
tickli task show <task-id> --json

# Delete a task in one line
tickli task delete $(tickli task create --title "temp" --quiet) --force

# Get today's tasks as JSON
tickli today --json

# Count overdue high priority tasks
tickli today -p high --quiet | wc -l

# Create an all-day task (no specific time)
tickli task create -t "Team offsite" --all-day --due "2025-03-20T00:00:00Z"

# Remove all-day status
tickli task update <task-id> --all-day=false

# Date formats accept timezone offsets with or without colon
tickli task create -t "Call" --start "2025-03-14T10:00:00+02:00" --due "2025-03-14T11:00:00+0200"

# Non-interactive fallback: piped/redirected output auto-detects non-TTY
echo "" | tickli today          # prints tab-separated rows instead of fuzzy selector
tickli today | cut -f3          # extract just the title column

# Duration field in JSON: computed from start/due when both are set
tickli task show <task-id> --json | jq .duration
tickli today --json | jq '.[] | select(.duration)'

Exit Codes

Configuration

Tickli stores its configuration at ~/.config/tickli/config.yaml (following the XDG Base Directory Specification).

You can set the default project with tickli project use.

Files

To log out, run tickli reset. This removes the access token and re-runs authentication.

Shell Completions

Enable tab completions for commands, flags, project IDs, and task IDs:

# Bash
tickli completion bash > /etc/bash_completion.d/tickli

# Zsh
tickli completion zsh > "${fpath[1]}/_tickli"

# Fish
tickli completion fish > ~/.config/fish/completions/tickli.fish

Restart your shell after installing.

Design Philosophy

Tickli is built to serve two audiences equally: humans at a terminal and AI agents (or scripts) driving it programmatically.

Graceful degradation, not separate modes. When stdin is a TTY, commands present an interactive fuzzy selector. When piped or redirected, they automatically fall back to machine-friendly tab-separated output. No extra flag is needed -the right behavior is inferred from context.

Consistent, predictable JSON. Every mutating command (create, update, complete, uncomplete, move, delete) returns the full task object in --json mode, not a minimal acknowledgement. Scripts can always parse the same shape. Computed fields like duration are included so callers don't need to recompute.

Flags should be unsurprising. Each flag name has one meaning across the entire CLI. Where the same concept appears in multiple commands, the flag name and semantics match (e.g. --to works on both move and update). Short flags (-a, -p, -t) are never overloaded within the same command.

Flexible input, strict output. Date parsing accepts both +02:00 and +0200 timezone offsets because producers vary. Output always uses a single canonical format. --all-day automatically strips time components rather than requiring the caller to zero them manually.

Don't hide the escape hatch. Boolean flags like --all-day support explicit =false so that both setting and unsetting are scriptable without needing a separate --no-all-day flag.

Minimal context required. Single-entity commands — whether for tasks (show, update, delete, complete, uncomplete, move) or projects (show, update, delete) — only need an ID. Task commands search all projects automatically. The --project flag is only required for task list and task create, where a scope is genuinely ambiguous. Smart views (today, tomorrow, week, inbox, all) require no arguments at all.

Three-tier output with override hierarchy. Output comes in three formats: simple (human-readable), json (machine-readable), and quiet (IDs only, for piping). The persistent --json and --quiet flags override the per-command -o flag, so a wrapper script can force JSON globally without modifying individual commands.

Stdout is data, stderr is diagnostics. Structured output (JSON, plain) goes to stdout. Progress messages, warnings, and errors go to stderr. This keeps piped data clean and lets agents parse stdout without filtering noise.

Non-blocking by default. When stdin is not a TTY, commands never block waiting for interactive input. Every value that can be prompted for is also settable via a flag.

--help is the spec. Every command and flag carries a short, precise description. Usage examples are included for non-obvious patterns. Agents discover capabilities through --help, so it must be complete and parseable.

Semantic exit codes. Exit codes distinguish between success (0), general errors (1), usage errors (2), not-found (3), and auth failures (4). Scripts can branch on the exit code without parsing stderr.

Documentation

For complete documentation on all available commands:

tickli --help