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 and open it in Obsidian:

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

    Open the folder as a vault in Obsidian. When prompted, trust the vault to enable plugins.

    Go to Settings β†’ Files and links and make sure Wikilinks are enabled. Then go to Settings β†’ Core plugins and enable Bases and Templates.

    Have a look around. Check out the tasks/Overview.md, projects/Overview.md, and areas/Overview.md files to see the Bases 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, then set the folder note name to Overview.md.

  2. Install the Obsidian plugin

    The plugin isn’t in the Community Plugins store yet. See the installation instructions for how to install via BRAT or manually.

    In plugin settings, set the tasks directory to tasks (or wherever your tasks live).

    Now look at 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.