Skip to content

eudennis/ultimate-todoist-sync-for-obsidian-experiment

 
 

Repository files navigation

Another Simple Todoist Sync for Obsidian (BETA)

Create, edit and delete tasks from within Obsidian.md to your Todoist.

Warning

This is a fork from the Ultimate Todoist Sync plugin for Obsidian. I'm still working on fixing some things, but the main feature should be working. I'm considering this feature a beta. Feel free to contribute.

Some features works only Todoist -> Obsidian, others by-directional. Find more details on the feature table below.

Alt Text

Table of detailed features supported
Feature from Obsidian to Todoist from Todoist to Obsidian
Add task 🔜
Delete task 🔜
Modify task content
Modify task due date
Modify task due time 🔜
Modify task description 🔜 🔜
Modify task labels/tags 🔜
Mark task as completed
Mark task as uncompleted
Modify project 🔜 🔜
Modify section 🔜 🔜
Modify priority [1] 🔜
Add reminder
Add duration 🔜
Move tasks between files 🔜 🔜
Added-at date 🔜 🔜
Completed-at date 🔜 🔜
Task notes [2] 🔜
Optional app link
  • [1] Task priority only support one-way synchronization
  • [2] Task notes/comments only support one-way synchronization from Todoist to Obsidian.

Installation

Warning

The plugin will require the Todoist API token, which can be found on your Settings > Integrations > Developer (direct link here)

From within Obsidian

  1. Open Obsidian's Community plugins tab, within the Settings window
  2. Click Browse and search for Another Todoist Sync Plugin
  3. Back to Community plugins, find the Installed Plugins section and activate the Another Todoist Sync Plugin

Note

You can update the plugin following the same procedure, clicking Update instead of Install

Manually

  1. Download the latest release of the plugin from the Releases page.
  2. Extract the downloaded zip file and copy the entire folder to your Obsidian plugins directory.
  3. Enable the plugin in the Obsidian settings.

Configuration

  1. Open Obsidian's Settings window
  2. Select the Community plugins tab on the left
  3. Under Installed plugins, click the gear icon next to the Another Simple Todoist Sync plugin
  4. Enter your Todoist API token

Settings

  1. Automatic synchronization interval time The time interval for automatic synchronization is set to 300 seconds by default, which means it runs every 5 minutes. You can modify it yourself.
  2. Default project New tasks will be added to the default project, and you can change the default project in the settings.
  3. Sync Comments By default, comments on tasks are added below your task on Obsidian. With this enabled, it won't sync comments.
  4. Custom Sync Tag By default, sync new task with #tdsync, but you can change to #todoist
  5. Alternative Keywords When enabled, accept new keywords for date, due time and duration (@,$ and &).

Usage

Task format

Syntax Description Example
#tdsync Tasks marked with #tdsync[4] will be added to Todoist, while tasks without the #tdsync tag will not be processed. If you have enabled Full vault sync in the settings, #tdsync will be added automatically. - [ ] task #tdsync
📅YYYY-MM-DD The date format is 📅YYYY-MM-DD, indicating the due date of a task. - [ ] task content 📅2025-02-05 #todoist [1]
#tag Note that all tags without a project of the same name are treated as normal tags - [ ] task #tagA #tagB #tagC #todoist
!!<number> The priority of the task between 1 and 4. [2] - [ ] task !!1 #todoist
⏰HH:MM This sets the time of the task. If none is given, the default is 08:00 - [ ] task ⏰23:59[3]
⏳MMmin This sets the duration of the task - [ ] task ⏳30min[[5]]
///<section_name> This adds the task to a section with <section_name> - [ ] task ///section_name[7]
Usage footnotes
  • [1] Supports the following characters/emojis: 📅, 📆, 🗓, 🗓️, @ [6]
  • [2] It's follow the same pattern of p1, p2, p3 and p4, p1 being the highest priority.
  • [3] Supports the following characters/emojis: ⏰, ⏲, $ [6]
  • [4] On the original plugin, this tag was #todoist, but on this fork was changed to avoid conflicts.
  • [5] Supports the following characters/emojis: ⏳, & [6]
  • [6] Alternative characters are enabled via "Alternative Keywords" on plugin settings page
  • [7] If the section if removed from the task content, it won't update in Todoist (yet)

Set a default project for each file separately

The default project in the setting applies to all files. You can set a separate default project for each file using the comand Set default project for Todoist task in the current file from the command menu.

Disclaimer

This plugin is for learning purposes only. The author and contributors makes no representations or warranties of any kind, express or implied, about the accuracy, completeness, or usefulness of this plugin and shall not be liable for any losses or damages resulting from the use of this plugin.

The author shall not be responsible for any loss or damage, including but not limited to data loss, system crashes, computer damage, or any other form of loss arising from software problems or errors. Users assume all risks and are solely responsible for any consequences resulting from the use of this product.

By using this plugin, you agree to be bound by all the terms of this disclaimer. If you have any questions, please contact the author.

Contributing

Contributions are welcome! If you'd like to contribute to the plugin, please feel free to submit a pull request.

License

This plugin is released under the GNU GPLv3 License.

About

Obsidian.md plugin to integrate with Todoist app.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • TypeScript 95.8%
  • JavaScript 4.0%
  • CSS 0.2%