kdnk / roamist

Todoist ❤️ Roam Research

🚧 WORK IN PROGRESS 🚧

This is a work in progress, and breaking changes to the setup/config could occur in the future. If you have any trouble, don't hesitate to create new Issues or contact me on the #roamist channel on Roam Slack. Sorry for any inconvenience.

CleanShot.2022-01-21.at.23.49.40.mp4

Table of Contents

1. Table of Contents
2. Motivation
3. Prerequires
4. Setup
   • 1. Install Roamist
   • 2. Configure Roamist
   • 3. See [[roam/roamist]]
   • 4. Run Roamist - pull ... smartblocks
   • 5. Place a button on the [[Roamist]] page.
5. Workflows
   • pull-tasks
   • sync-completed
   • complete-task
   • quick-capture
6. roam/css for priority
7. Inspired

Motivation

I have been using Todoist as my task management tool for a long time.
I still think that Roam Research is the best note-taking tool, but Todoist is more suitable for task management.

Since I started using Roam Research, I've wondered if it would be possible to use Todoist for task management but take detailed notes for each task in Roam Research.

Roamist is one way to make this possible. With this integration, you can copy tasks from Todoist to Roam Research, complete Todoist tasks from within Roam Reasearch, and synchronize task completion status between Todoist and Roam Reserach.

Prerequires

• Todoist’s api token
  • See: https://developer.todoist.com/rest/v1/#javascript-sdk
  • You can get your token on https://todoist.com/prefs/integrations.
• SmartBlocks (You can install it through roam-depot)
  • https://roamjs.com/extensions/smartblocks

Setup

1. Install Roamist

• Install Roamist through roam-depot.
• You can see [[roam/roamist]] is created.

2. Configure Roamist

• Fill Todoist's token, and Todoist filters.
  • Todoist's token
    • You can get your token via todoist.com/prefs/integrations.
  • Todoist filters
    • left:
      • Name of your filter.
        • ex. Today's work
    • right:
      • Todoist filter. https://todoist.com/help/articles/205248842.
        • ex. (today | overdue) & #Work

3. See [[roam/roamist]]

• You can see some blocks are added automatically if you set Todoist filters correctlly.
  • Please don't modify blocks of this page. That makes Roamist broken.
• Roamist - pull today (only diff) is designed to ignore blocks that already exist on the page where smartblock is executed.
  • This is useful if you only want to bring tasks that are newly added to Todoist into Roam.

You can edit, add or remove filters at any time.
Roamist will do its best to automatically reflect them, but if you have problems, first try removing the workflows block on the [[roam/roamist]] page and then reload Roam.

4. Run Roamist - pull ... smartblocks

• Run smartblocks on any page you like.
  • If you have set it up properly so far, you should be able to run smartblocks with a name like Roamist - pull ....
  • If there are no tasks in Todoist, nothing will be imported, so make sure you have tasks in Todoist.

5. Place a button on the [[Roamist]] page.

Have you been able to import tasks from Todoist?
The block you have imported will be labeled #Roamist. Let's navigate to this page.
In the first block on [[Roamist]] page, enter a block like this.

- `{{Sync todoist completed:42SmartBlock:Roamist - sync completed:button=true,42RemoveButton=false}}`

You can use this button to reflect the completion status of Todoist tasks into Roam. There is no need to change each TODO to DONE on Roam.

Workflows

⚠️ This integration recognizes the Todoist id using a tag like Todoist/1234567890.
You must NOT remove this tag.
If you do, Roamist won't work as intended.

pull-tasks

• This workflow will pull tasks with the Todoist's Filters.
  • You can set your filter in [[roam/roamist]]
    • 
• Block will look like this.
  • 

sync-completed

• This workflow will sync completion status from Todoist to Roam Research.
• I recommend you use this workflow as a button in [[Roamist]] as follows.
  • {{Sync todoist completed:SmartBlock:Roamist - sync completed:RemoveButton=false}}
  • 

sync-completed-dnp

• This is almost the same one as sync-completed, but it only works for a single day.
• It's supposed to be used in DNP.
• It might be useful if you have recurring tasks.
• I would recommend you put the following button in your daily template.
  • {{Sync todoist DNP completed:SmartBlock:Roamist - sync completed (DNP):RemoveButton=false}}

complete-task

• This workflow will complete a task under your cursor.
  • After running this workflow, {{[[TODO]]}} will turn into {{[[DONE]]}} automatically.

quick-capture

• This workflow pulls Todoist's tasks.
  • Todoist's filter for quick Capture is used.
  • Unlike pull-tasks, this workflow marks Todoist's tasks as completed.
  • ex. If you set like #Quick Caputure, whole tasks in Quick Capture product of todoist will be copied, and original tasks are marked as completed.

roam/css for priority

• I recommend you set css for todoist's priority.
  • ref. https://roamresearch.com/#/app/help/page/RA1UXmzp0

- #priority/p1 #priority/p2 #priority/p3 #priority/p4
    - ```css
    @import url('https://kdnk.github.io/roamist/style.css');
    ```

Inspired

• dvargas92495/roam42
• Universal Quick Capture for Roam Research Beta