Installation - Obsidian-Tasks-Sync/obsidian-tasks-sync GitHub Wiki

Installation

1. Clone the Repository

Clone this repository or download it as a ZIP and extract it under your Obsidian vault’s plugin folder:

git clone https://github.com/hong-sile/obsidian-tasks-sync.git

Target folder structure:

/YourVault/.obsidian/plugins/obsidian-tasks-sync

2. Install Dependencies

Open a terminal in the plugin directory and install dependencies:

pnpm install

3. Start the Plugin in Development Mode

To run the plugin in development mode:

pnpm run dev

If you encounter an error related to missing modules, add them manually:

pnpm add -D builtin-modules
pnpm run dev

Expected output:

[watch] build finished, watching for changes...

4. Enable the Plugin in Obsidian

In Obsidian:

  • Go to Settings → Community Plugins
  • Enable Obsidian Tasks Sync from the plugin list

Google API Setup

Step 1: Create a Google Cloud Project

  1. Go to Google Workspace Console
  2. Click “Create Project”
  3. Set user type to External on the OAuth consent screen
  4. Add your Gmail account as a test user

Step 2: Create OAuth Credentials

  1. Go to Credentials → “Create Credentials” → OAuth client ID

  2. Choose Web application

  3. Add the following:

    • Authorized JavaScript origin: http://127.0.0.1:42813
    • Authorized redirect URI: http://127.0.0.1:42813/callback

  4. Save the Client ID and Client Secret

Step 3: Input Credentials in Obsidian

In Obsidian plugin settings:

  1. Navigate to Settings → Obsidian Tasks Sync
  2. Enter your Client ID and Client Secret
  3. Click "Connect to Google"

Upon successful login, the plugin will be authenticated and ready to sync with your Google Tasks.