Skip to content

Setup Guide

This guide walks through setting up the full Taskdn suite. It assumes you already have Obsidian and Claude Code installed.

  1. Set up the starter vault

    Clone the starter vault (it needs Obsidian 1.14 or later):

    Terminal window
    git clone https://github.com/dannysmith/tdn-obsidian-starter-vault my-tasks
    cd my-tasks
    ./shift-dates.sh
    rm -rf .git README.md shift-dates.sh

    ./shift-dates.sh is optional. It moves the example dates so they’re relative to today.

    In Obsidian, click Open folder as vault and choose the cloned folder. Bases, Templates and wikilinks are already set up.

    Have a look around. The vault opens on Start Here.md, a dashboard with today’s tasks, a task board and your active projects. The Overview.md files in tasks/, projects/ and areas/ have more views.

    Optional: Folder Notes plugin

    The Folder Notes plugin makes the Overview files open automatically when you click a folder. Install it from Community Plugins, set the folder note name to Overview, then restart Obsidian.

  2. Install the Obsidian plugin

    With your vault open in Obsidian, click this button to open Taskdn’s page in Obsidian’s plugin browser, then click Install and Enable:

    Add to Obsidian

    If the button doesn’t open Obsidian, go to Settings → Community plugins, turn on community plugins, click Browse and search for “Taskdn”. You can also install it manually.

    In Settings → Taskdn, set Ignored files to Overview.md. The default tasks directory, tasks, already matches the starter vault.

    Now open example-note.md in your vault to see task links rendered as interactive widgets. Click a checkbox to mark a task done.

  3. Install and configure the CLI

    Install the CLI:

    Terminal window
    brew tap dannysmith/taproom && brew install tdn

    Create a config file pointing to your vault:

    Terminal window
    tdn init

    Try it out:

    Terminal window
    tdn context

    You should see an overview of your areas, projects, and tasks.

  4. Install the Claude Code plugin

    In Claude Code, install the plugin globally:

    /plugin marketplace add dannysmith/taskdn
    /plugin install tdn@tdn-marketplace

    Try asking Claude about your tasks:

    /tdn:today

    Or just ask naturally: “What’s on my plate this week?”

  5. Install the desktop app

    Once installed, point it at your vault directory and you’ll see your tasks in a proper task management UI.