search

HeroBlackInk / ultimate-todoist-sync-for-obsidian

GNU General Public License v3.0
152 stars 24 forks source link

readme

Ultimate Todoist Sync for Obsidian

The Ultimate Todoist Sync plugin automatically creates tasks in Todoist and synchronizes task state between Obsidian and Todoist.

Demo

Usage

Alt Text

Settings page

Features

Feature Sync from Obsidian to Todoist Sync from Todoist to Obsidian Description
Add task ✅ 🔜
Delete task ✅ 🔜
Modify task content ✅ ✅
Modify task due date ✅ ✅
Modify task description 🔜 🔜
Modify task labels/tags ✅ 🔜
Mark task as completed ✅ ✅
Mark task as uncompleted ✅ ✅
Modify project 🔜 🔜
Modify section 🔜 🔜
Modify priority ✅ 🔜 Currently, task priority only support one-way synchronization from Todoist to Obsidian.
Add reminder 🔜 🔜
Move tasks between files 🔜 🔜
Added-at date 🔜 🔜
Completed-at date 🔜 🔜
Task notes 🔜 ✅ Currently, task notes/comments only support one-way synchronization from Todoist to Obsidian.

Installation

From within Obsidian

From Obsidian v1.3.5+, you can activate this plugin within Obsidian by doing the following:

  1. Open Obsidian's Settings window
  2. Select the Community plugins tab on the left
  3. Make sure Restricted mode is off
  4. Click Browse next to Community Plugins
  5. Search for and click on Ultimate Todoist Sync
  6. Click Install
  7. Once installed, close the Community Plugins window
  8. Under Installed Plugins, activate the Ultimate Todoist Sync plugin

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

Manually

If you would rather install the plugin manually, you can do the following:

  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 Ultimate 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. Full vault sync By enabling this option, the plugin will automatically add #todoist to all tasks, which will modify all files in the vault.

Usage

Task format

Syntax Description Example
#todoist Tasks marked with #todoist will be added to Todoist, while tasks without the #todoist tag will not be processed.If you have enabled Full vault sync in the settings, #todoist will be added automatically. - [ ] task #todoist
📅YYYY-MM-DD The date format is 📅YYYY-MM-DD, indicating the due date of a task. - [ ] task content 📅2025-02-05 #todoist
Supports the following calendar emojis.📅📆🗓🗓️
#projectTag New tasks will be added to the default project(For example, inbox .), and you can change the default project in the settings or use a tag with the same name to specify a particular project. - [ ] taskA #todoist will be added to inbox.
- [ ] taskB #tag #testProject #todoist will be added to testProject.
#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 (a number between 1 and 4, 4 for very urgent and 1 for natural).
Note: Keep in mind that very urgent is the priority 1 on clients. So, the priority 1 in the client corresponds to the number 4 here (Because that's how the official API of Todoist is designed.).		 - [ ] task !!4 #todoist

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 command.

You can see the current file's default project in the status bar at the bottom right corner.

Disclaimer

This plugin is for learning purposes only. The author 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.