todo.md

tlgr todo

5 operations. Every one takes the global flags (--json, --plain, -a/--account, --results-only, --select, --dry-run, --yes, --no-input, --flood-wait-max, -v) anywhere on the line.

Command	Summary
todo add	Append tasks to an existing checklist
todo create	Send a checklist / to-do list
todo edit	Rename a checklist, remove or add tasks, change who may add or tick
todo get	Read a checklist: tasks, who ticked what and when
todo toggle	Tick and untick checklist tasks in one call

todo add

Append tasks to an existing checklist.

Ids continue from the highest one the list already has; they are never reused, because a completion is keyed by task id.

tlgr todo add <CHAT> <MSG_ID> [TASK]... [OPTIONS]

mutating · returns Todo

Argument	Type	Required	Meaning
CHAT	chat	yes	Chat.
MSG_ID	msg-id	yes	Checklist message id.
TASK	text	one or more	Tasks to append.

Flag	Type	Default	Meaning
--parse	text		md

$ tlgr todo add @team 12345 'sign the release' --json

Catalog coverage (1 full, 0 partial)

Full: messages-core.checklist-append-tasks

todo create

Send a checklist / to-do list.

Creating a checklist needs Telegram Premium. Task ids are assigned 1..n and are the handle every other todo command uses.

tlgr todo create <CHAT> <TITLE> [TASK]... [OPTIONS]

mutating · returns Todo

Argument	Type	Required	Meaning
CHAT	chat	yes	Where to post it.
TITLE	text	yes	The list's title.
TASK	text	one or more	The tasks, in order.

Flag	Type	Default	Meaning
--effect	text		Animated message effect (private chats).
--others-can-add	flag		Anyone may append tasks.
--others-can-complete	flag		Anyone may tick tasks.
--paid-stars	int		Agree to pay N Stars per message.
--parse	text		md
--protect, --noforwards	flag		noforwards: block forwarding and saving.
--quick-reply	text		Send through a business quick reply.
--repeat	daily	weekly	biweekly
--reply-to	msg-id		Reply to this message.
--schedule	text		Send later; 'online' means when the recipient is next online.
--send-as	chat		Post as a channel or anonymously.
--silent	flag		Send without a notification sound.
--topic	msg-id		Send inside a forum topic.
--typing	number		Show a typing action first.
--typing-auto	flag		Type for a duration estimated from the text length.

Also invocable as: tlgr message checklist

$ tlgr todo create @team 'Release checklist' 'tag the commit' 'publish the wheel' --json

Catalog coverage (2 full, 0 partial)

Full: messages-core.checklist-create, todo.create

todo edit

Rename a checklist, remove or add tasks, change who may add or tick.

Surviving tasks keep their ids: completions are keyed by id, and renumbering would move every tick onto a different task.

tlgr todo edit <CHAT> <MSG_ID> [OPTIONS]

mutating · returns Todo

Argument	Type	Required	Meaning
CHAT	chat	yes	Chat.
MSG_ID	msg-id	yes	Checklist message id.

Flag	Type	Default	Meaning
--add-task	text		Add a task; repeatable.
--others-can-add	text		Who may append.
--others-can-complete	text		Who may tick.
--parse	text		md
--remove-task	text		Remove a task id; repeatable.
--rename-task	text		Retitle a task; repeatable.
--title	text		New title.

$ tlgr todo edit @team 12345 --title 'Release 2.0' --json

Catalog coverage (3 full, 0 partial)

Full: messages-core.checklist-edit, todo.edit-list, todo.permissions

todo get

Read a checklist: tasks, who ticked what and when.

tlgr todo get <CHAT> <MSG_ID> [OPTIONS]

returns Todo

Argument	Type	Required	Meaning
CHAT	chat	yes	Chat.
MSG_ID	msg-id	yes	Checklist message id.

$ tlgr todo get @team 12345 --json

Catalog coverage (1 full, 0 partial)

Full: todo.view-completions

todo toggle

Tick and untick checklist tasks in one call.

Needs to be the author unless the list was created with --others-can-complete. A no-op is already: true.

tlgr todo toggle <CHAT> <MSG_ID> [OPTIONS]

mutating · idempotent (reports already) · returns Todo

Argument	Type	Required	Meaning
CHAT	chat	yes	Chat.
MSG_ID	msg-id	yes	Checklist message id.

Flag	Type	Default	Meaning
--done	text		Task ids to tick.
--send-as	chat		Tick as a channel or anonymously.
--undone	text		Task ids to untick.

Also invocable as: tlgr todo done, tlgr todo undone

$ tlgr todo toggle @team 12345 --done 1 --json

Catalog coverage (3 full, 0 partial)

Full: messages-core.checklist-toggle-task, todo.send-as, todo.toggle-completed