Skip to content

OgnjenKop/ticktick-cli

Repository files navigation

TickTick CLI

A TypeScript command-line client for managing TickTick tasks and projects.

Features

  • Authenticate with TickTick (credentials or browser-assisted flow)
  • List, create, update, complete, and delete tasks
  • List, create, update, and delete projects
  • Interactive prompts for missing command options

Requirements

  • Node.js 18+
  • npm

Installation

Local development

npm install
npm run build
npm link

After linking, use the CLI with:

tt --help

From npm (when published)

npm install -g ticktick-cli

Quick Start

  1. Authenticate:
tt auth login
  1. Check auth status:
tt auth status
  1. Create a task:
tt tasks add --title "Pay electricity bill" --project inbox --due 2026-03-05
  1. List tasks:
tt tasks list

Commands

Authentication

  • tt auth login
  • tt auth login --username <username> --password <password>
  • tt auth logout
  • tt auth status
  • tt auth whoami

Notes:

  • Browser login is partially manual in the current implementation.
  • You may be prompted to paste TickTick session cookie t=....

Tasks

  • tt tasks list
  • tt tasks list --project <projectId>
  • tt tasks list --completed
  • tt tasks list --uncompleted
  • tt tasks add --title <title> [--content <content>] [--project <projectId>] [--due YYYY-MM-DD]
  • tt tasks show <id>
  • tt tasks update <id> [--title <title>] [--content <content>] [--project <projectId>] [--due YYYY-MM-DD] [--completed|--uncompleted]
  • tt tasks complete <id>
  • tt tasks uncomplete <id>
  • tt tasks delete <id>

Projects

  • tt projects list
  • tt projects add --name <name> [--color <hex>]
  • tt projects show <id>
  • tt projects update <id> [--name <name>] [--color <hex>]
  • tt projects delete <id>

Development

npm install
npm run build
npm run dev
npm test
npm run lint

Configuration

Authentication and user data are stored locally via configstore under the package name ticktick-cli.

License

MIT

About

TickTick CLI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors