@chordcode/ticktick

TickTick CLI

TickTick CLI is a cross-platform command-line tool that allows you to interact seamlessly with your TickTick tasks. Manage your reminders, create tasks, organize lists, and more—all directly from your terminal.

Features

• Add Tasks: Create new tasks with extended options like descriptions, tags, due dates, priorities, and reminders.
• Manage Lists: Retrieve and display your TickTick lists in both Markdown and JSON formats.
• Configuration Setup: Easy setup for authentication using TickTick's OAuth.
• Cross-Platform: Works on Windows, macOS, and Linux.
• Global Commands: Use ticktick or tt commands globally after installation.

Installation

Ensure you have Node.js installed, then install TickTick CLI globally using NPM:

npm install -g @chordcode/ticktick

Configuration

After installation, set up TickTick CLI by running the configuration command. The tool will guide you through the necessary steps automatically.

ticktick --configure

Usage

After installation and configuration, you can use the ticktick or tt command to manage your tasks.

Adding a Task

ticktick "Finish the report" -d notes.md -l "Work" -t "urgent" -D "next Monday" -p 2

Options:

• -c, --configure: Run the configuration setup.
• -d, --description <file>: Specify a Markdown file for the task description.
• -l, --list <list_name>: Specify the list to add the task to.
• -t, --tag <tag>: Add tags to the task (can be used multiple times).
• -D, --due-date <due_date>: Set the due date (e.g., "tomorrow", "2023-11-01 14:00").
• -s, --start-date <start_date>: Set the start date.
• -p, --priority <priority>: Set priority level (0: None, 1: Low, 2: Medium, 3: High).
• -r, --reminder <reminder>: Add reminders (can be used multiple times).
• -z, --timezone <timezone>: Set the time zone (e.g., "America/Los_Angeles").
• -A, --all-day: Set the task as an all-day task.

Listing Tasks

• Display tasks for a specific list in Markdown:

  ticktick -g "Work"
  

• Get list data in JSON format:

  ticktick -G "Work"
  

• List all list names:

  ticktick -ls
  

• List all lists in JSON format:

  ticktick -LS
  

Installing as a Global Command

To set up ticktick and tt as global commands:

ticktick -i

Note: Ensure the installation directory is in your PATH environment variable.

Examples

# Add a task with a description, tags, due date, and priority
ticktick "Prepare for the meeting" -d meeting_notes.md -t "work" -t "urgent" -D "tomorrow 10am" -p 3

# Display tasks for the 'Personal' list in formatted Markdown
tt -g "Personal"

# Get list data for 'Work' in JSON format
ticktick -G "Work"

# List all available lists
tt -ls

License

This project is licensed under the MIT License.

Acknowledgements

Developed by ChordCode with support from AI technologies.

Quick Start

• Install TickTick CLI:

  npm install -g @chordcode/ticktick
  

• Configure the CLI:

  ticktick --configure
  

• Start managing your tasks from the command line!

Enjoy seamless task management with TickTick CLI!