@pingvinen/donna-assistant 0.4.0 → 0.6.0

package/README.md

@@ -1,2 +1,131 @@
-# donna
-A Claude skill based personal assistant
+# Donna
+
+Your personal, digital version of Harvey Specter's amazing secretary.
+
+Donna is an AI-powered personal assistant that manages the work that falls through the cracks — the 1:1 follow-ups, recurring process tasks, stakeholder requests, and self-initiated work that never makes it into Jira or Linear.
+
+She lives inside your terminal. She knows your role, surfaces what needs attention each day, pulls data from your CLI tools, and captures tasks in seconds — all backed by plain markdown and git.
+
+Donna is designed to be AI-agnostic, but currently only tested with [Claude Code](https://docs.anthropic.com/en/docs/claude-code). She works from any session, in any project — your tasks follow you wherever you work.
+
+## Install
+
+```bash
+npx @pingvinen/donna-assistant
+```
+
+The installer copies skill files into `~/.claude/commands/donna/` and shared runtime into `~/.donna/`. Run it again to upgrade.
+
+**Requirements:** Node.js 18+, an AI coding assistant (tested with Claude Code)
+
+## Setup
+
+```
+/donna:setup
+```
+
+Donna will ask you for a **storage repo** — a git repository (local or remote) where all your tasks and daily files live. Everything is plain markdown, committed to git automatically. If you use [Obsidian](https://obsidian.md), you can open this repo as a vault for a free UI.
+
+Then define your role so Donna can suggest recurring tasks relevant to your job:
+
+```
+/donna:set-role
+```
+
+## Daily workflow
+
+### Start the day
+
+```
+/donna:begin-the-day
+```
+
+This is your morning ritual. Donna will:
+
+- **Carry forward** open tasks from your last working day (handles weekends)
+- **Surface recurring tasks** that are due today based on your role
+- **Pull fresh data** from configured tools (GitHub PRs, Jira tickets, etc.)
+- **Deduplicate** across all sources and give you a brief
+
+### Capture tasks throughout the day
+
+```
+/donna:add-task Review Sarah's design doc before Thursday
+```
+
+One command, zero prompts, committed to git in seconds. Can also be called without arguments for a more conversational capture.
+
+### Mark tasks done
+
+```
+/donna:done design doc
+```
+
+Fuzzy-matches by name. Run without arguments to pick from a list.
+
+### Refresh tool data mid-day
+
+```
+/donna:run-tools
+```
+
+Re-pulls data from all configured tools. New items appear, resolved items get closed automatically. Your manually-marked tasks always win.
+
+## External tools
+
+Donna can pull tasks and status from CLI tools you already have installed. Register them with:
+
+```
+/donna:add-tool gh
+```
+
+Or call it without arguments — Donna will check your role and suggest tools typically associated with your job.
+
+Donna verifies the tool is installed and authenticated, learns its capabilities, and asks what scope to query (which repos, projects, namespaces). Any CLI tool can be added — Donna uses the AI model's knowledge of well-known tools and parses `--help` output for everything else.
+
+If a tool version is newer than what the AI model knows, Donna will inspect it to learn its current capabilities. You can also re-learn tools at any time:
+
+```
+/donna:relearn-tools
+```
+
+## How state is stored
+
+```
+<your-storage-repo>/
+  donna/
+    role.md          # your job role definition
+    recurring.md     # recurring task schedule
+    tools.md         # registered tool configurations
+  daily/
+    2026-03-16.md    # today's tasks, tool data, notes
+    2026-03-15.md
+    ...
+```
+
+Every change is committed to git. Files are plain markdown with YAML frontmatter — human-readable, hand-editable, and version-controlled.
+
+The storage repo is yours. Donna only writes to the `donna/` and `daily/` directories, so you're free to keep any other notes, files, or folder structures alongside it — great if you're already using the repo as an Obsidian vault or similar.
+
+## Idempotent by design
+
+Most commands are safe to run again. Want to update your role? Run `/donna:set-role` again. Added a new tool mid-day? Run `/donna:begin-the-day` again to pull its data in. Re-running a command updates state rather than duplicating it.
+
+## All commands
+
+| Command | What it does |
+|---------|-------------|
+| `/donna:setup` | First-time configuration (storage repo, directories) |
+| `/donna:set-role` | Define your job role, get recurring task suggestions |
+| `/donna:begin-the-day` | Morning brief with carry-forward, recurring tasks, tool data |
+| `/donna:add-task` | Capture a task instantly |
+| `/donna:done` | Mark a task complete |
+| `/donna:add-tool` | Register an external CLI tool |
+| `/donna:run-tools` | Refresh tool data mid-day |
+| `/donna:relearn-tools` | Update tool knowledge after upgrades |
+| `/donna:help` | Conversational troubleshooting for config, storage, or skill issues |
+| `/donna:contribute-idea` | Submit a feature idea or bug report via GitHub Issues |
+
+## License
+
+MIT

package/migrations/002-standing-files-subfolder.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+module.exports = {
+    version: "0.4.0",
+    description: "Queue standing file move to donna/ subfolder (runs on next skill use)",
+    up(ctx) {
+        // Standing files live in the user's storage repo, which is not accessible
+        // from the migration context. We write a pending flag to state.md so that
+        // workflows can detect and execute the move on next skill run.
+        const statePath = ctx.path.join(ctx.donnaDir, "state.md");
+
+        if (ctx.fs.existsSync(statePath)) {
+            const content = ctx.fs.readFileSync(statePath, "utf8");
+            if (content.includes("move-standing-files")) {
+                // Already queued — idempotent, nothing to do
+                return;
+            }
+        }
+
+        const pendingFlag = "---\npending_migrations:\n  - move-standing-files\n---\n";
+        ctx.fs.writeFileSync(statePath, pendingFlag, "utf8");
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pingvinen/donna-assistant",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Donna - your AI powered personal assistant",
   "bin": {
     "donna-assistant": "./bin/donna-assistant"

package/src/changelog.cjs

@@ -0,0 +1,70 @@
+"use strict";
+
+const output = require("./output.cjs");
+
+/**
+ * Changelog data keyed by version string.
+ * Each entry has categories as keys and arrays of change descriptions as values.
+ */
+const CHANGELOG = {
+    "0.5.0": {
+        "New skills": [
+            "donna:help — conversational troubleshooting and diagnostics",
+            "donna:contribute-idea — submit feature ideas via GitHub Issues",
+        ],
+        Improvements: [
+            "CONTRIBUTING.md developer guide added",
+            "Upgrade changelog shown during version bumps",
+        ],
+    },
+};
+
+/**
+ * Compare two semver strings. Returns true if a > b.
+ *
+ * @param {string} a - First version string
+ * @param {string} b - Second version string
+ * @returns {boolean}
+ */
+function semverGt(a, b) {
+    const pa = a.split(".").map(Number);
+    const pb = b.split(".").map(Number);
+    for (let i = 0; i < 3; i++) {
+        if (pa[i] > pb[i]) return true;
+        if (pa[i] < pb[i]) return false;
+    }
+    return false;
+}
+
+/**
+ * Display changelog entries for versions between fromVersion (exclusive)
+ * and toVersion (inclusive).
+ *
+ * @param {string} fromVersion - Previous version (exclusive)
+ * @param {string} toVersion - New version (inclusive)
+ */
+function displayChangelog(fromVersion, toVersion) {
+    const versionsToShow = Object.keys(CHANGELOG)
+        .filter((v) => semverGt(v, fromVersion) && !semverGt(v, toVersion))
+        .sort((a, b) => (semverGt(a, b) ? 1 : -1));
+
+    if (versionsToShow.length === 0) return;
+
+    console.log("");
+    output.info("What's new:");
+
+    for (const ver of versionsToShow) {
+        const entry = CHANGELOG[ver];
+        for (const [category, items] of Object.entries(entry)) {
+            output.info(`  ${category}:`);
+            for (const item of items) {
+                const prefix = category.toLowerCase().includes("new") ? "+" : "\u00b7";
+                output.info(`    ${prefix} ${item}`);
+            }
+        }
+    }
+
+    console.log("");
+}
+
+module.exports = { CHANGELOG, displayChangelog, semverGt };

package/src/installer.cjs

@@ -8,6 +8,7 @@ const output = require("./output.cjs");
 const version = require("./version.cjs");
 const migrator = require("./migrator.cjs");
 const providers = require("./providers/index.cjs");
+const changelog = require("./changelog.cjs");
 
 /**
  * Main installer orchestration.
@@ -50,6 +51,7 @@ async function run(options = {}) {
     // If upgrading (current version exists but differs)
     if (currentVersion && currentVersion !== packageVersion) {
         output.upgradeHeader(currentVersion, packageVersion);
+        changelog.displayChangelog(currentVersion, packageVersion);
     }
 
     // Run migrations
@@ -77,7 +79,7 @@ async function run(options = {}) {
         for (const provider of detected) {
             fs.cpSync(provider.stubSource, provider.stubTarget, { recursive: true });
             output.success(
-                `Copied donna skills (setup, add-task, done, set-role, begin-the-day) to ${provider.stubTarget}`,
+                `Copied donna skills (setup, add-task, done, set-role, begin-the-day, add-tool, relearn-tools, run-tools, help, contribute-idea) to ${provider.stubTarget}`,
             );
         }
     } else {

package/src/output.cjs

@@ -26,4 +26,9 @@ function migrationLine(desc) {
     console.log(`  \u2713 ${desc}`);
 }
 
-module.exports = { banner, success, fail, info, upgradeHeader, migrationLine };
+function changelogHeader() {
+    console.log("");
+    console.log("  What's new:");
+}
+
+module.exports = { banner, success, fail, info, upgradeHeader, migrationLine, changelogHeader };

package/stubs/claude-code/donna/add-tool.md

@@ -0,0 +1,17 @@
+---
+name: donna:add-tool
+description: Declare an external CLI tool and teach Donna its capabilities
+allowed-tools:
+  - Read
+  - Write
+  - Bash
+  - AskUserQuestion
+---
+
+<objective>
+Run the Donna add-tool workflow. This command declares external CLI tools (like gh, jira, kubectl) and teaches Donna their capabilities so they can be surfaced in the daily brief.
+</objective>
+
+<execution_context>
+@~/.donna/workflows/add-tool.md
+</execution_context>

package/stubs/claude-code/donna/contribute-idea.md

@@ -0,0 +1,16 @@
+---
+name: donna:contribute-idea
+description: Submit a feature idea or bug report — checks for duplicates, then creates a GitHub Issue
+allowed-tools:
+  - Read
+  - Bash
+  - AskUserQuestion
+---
+
+<objective>
+Run the Donna contribute-idea workflow. This command helps users submit feature ideas or bug reports by checking for duplicates against existing GitHub Issues and the project's pending todos, then creating a new issue if the idea is novel.
+</objective>
+
+<execution_context>
+@~/.donna/workflows/contribute-idea.md
+</execution_context>

package/stubs/claude-code/donna/help.md

@@ -0,0 +1,16 @@
+---
+name: donna:help
+description: Conversational troubleshooting — diagnose issues with Donna's config, storage, skills, or tools
+allowed-tools:
+  - Read
+  - Bash
+  - AskUserQuestion
+---
+
+<objective>
+Run the Donna help workflow. This command provides interactive troubleshooting by inspecting Donna's state and guiding the user through diagnosing and resolving issues.
+</objective>
+
+<execution_context>
+@~/.donna/workflows/help.md
+</execution_context>

package/stubs/claude-code/donna/relearn-tools.md

@@ -0,0 +1,16 @@
+---
+name: donna:relearn-tools
+description: Re-learn capabilities for tools whose installed version has changed
+allowed-tools:
+  - Read
+  - Write
+  - Bash
+---
+
+<objective>
+Run the Donna relearn-tools workflow. This command checks each registered tool's installed version against its stored version and re-learns capabilities for tools that have been updated.
+</objective>
+
+<execution_context>
+@~/.donna/workflows/relearn-tools.md
+</execution_context>

package/stubs/claude-code/donna/run-tools.md

@@ -0,0 +1,16 @@
+---
+name: donna:run-tools
+description: Run external tools and pull fresh data into today's daily file
+allowed-tools:
+  - Read
+  - Write
+  - Bash
+---
+
+<objective>
+Run the Donna run-tools workflow. This command executes all configured external tool commands, pulls fresh data, and smart-merges results into today's daily file, without running the full begin-the-day carry-forward and recurring task logic.
+</objective>
+
+<execution_context>
+@~/.donna/workflows/run-tools.md
+</execution_context>

package/workflows/add-task.md

@@ -21,6 +21,47 @@ Extract the `storage_repo`, `daily_folder` (default: `daily`), and `auto_push` (
 - Otherwise: do nothing.
 </step>
 
+<step name="check-pending-migrations">
+Read `~/.donna/state.md` with the Read tool. If the file does not exist or has no `pending_migrations` field in its YAML frontmatter, skip this step.
+
+For each entry in `pending_migrations`:
+
+**`move-standing-files`:** Move standing files from storage repo root to donna/ subfolder.
+
+Run via Bash:
+```bash
+STORAGE_REPO="<storage_repo>"
+DONNA_DIR="$STORAGE_REPO/donna"
+MOVED=0
+
+mkdir -p "$DONNA_DIR"
+for FILE in role.md recurring.md role-research.md; do
+    if [ -f "$STORAGE_REPO/$FILE" ] && [ ! -f "$DONNA_DIR/$FILE" ]; then
+        mv "$STORAGE_REPO/$FILE" "$DONNA_DIR/$FILE"
+        echo "Moved $FILE to donna/$FILE"
+        MOVED=$((MOVED + 1))
+    fi
+done
+
+echo "MOVED=$MOVED"
+```
+
+If MOVED > 0, commit the move:
+```bash
+git -C <storage_repo> add -A
+git -C <storage_repo> diff --cached --quiet || git -C <storage_repo> commit -m "donna(migrate): move standing files to donna/ subfolder"
+```
+
+If `auto_push` is true in config, also push.
+
+After processing all pending migrations, update `~/.donna/state.md` with the Write tool: remove the completed entries from `pending_migrations`. If no entries remain, write:
+```markdown
+---
+pending_migrations: []
+---
+```
+</step>
+
 <step name="get-description">
 The task description is provided as the argument to this command (e.g., `/donna:add-task buy milk`).
 

package/workflows/add-tool.md

@@ -0,0 +1,261 @@
+# Donna Add-Tool Workflow
+
+<objective>
+Declare an external CLI tool, verify its installation and authentication, learn its capabilities, and persist the result to tools.md in the storage repo.
+</objective>
+
+<step name="read-config">
+Read `~/.config/donna/config.md`.
+
+If the file does not exist, print:
+```
+✗ Donna is not configured. Run /donna:setup first.
+```
+Stop.
+
+Extract the `storage_repo`, `daily_folder` (default: `daily`), and `auto_push` (default: false) fields from the YAML frontmatter.
+
+**Obsidian sync:** Check if `<storage_repo>/.obsidian/daily-notes.json` exists.
+- If it exists and has a `folder` field that differs from `<daily_folder>`: update `<daily_folder>` to match Obsidian's value, and update `~/.config/donna/config.md` with the new `daily_folder`. Print `✓ Synced daily folder with Obsidian: <daily_folder>`.
+- If `<storage_repo>/.obsidian/` exists but `daily-notes.json` does not exist or has no `folder` field: write `<storage_repo>/.obsidian/daily-notes.json` with `{"folder":"<daily_folder>"}`. Print `✓ Configured Obsidian daily notes to use <daily_folder>/`.
+- Otherwise: do nothing.
+</step>
+
+<step name="check-pending-migrations">
+Read `~/.donna/state.md` with the Read tool. If the file does not exist or has no `pending_migrations` field in its YAML frontmatter, skip this step.
+
+For each entry in `pending_migrations`:
+
+**`move-standing-files`:** Move standing files from storage repo root to donna/ subfolder.
+
+Run via Bash:
+```bash
+STORAGE_REPO="<storage_repo>"
+DONNA_DIR="$STORAGE_REPO/donna"
+MOVED=0
+
+mkdir -p "$DONNA_DIR"
+for FILE in role.md recurring.md role-research.md; do
+    if [ -f "$STORAGE_REPO/$FILE" ] && [ ! -f "$DONNA_DIR/$FILE" ]; then
+        mv "$STORAGE_REPO/$FILE" "$DONNA_DIR/$FILE"
+        echo "Moved $FILE to donna/$FILE"
+        MOVED=$((MOVED + 1))
+    fi
+done
+
+echo "MOVED=$MOVED"
+```
+
+If MOVED > 0, commit the move:
+```bash
+git -C <storage_repo> add -A
+git -C <storage_repo> diff --cached --quiet || git -C <storage_repo> commit -m "donna(migrate): move standing files to donna/ subfolder"
+```
+
+If `auto_push` is true in config, also push.
+
+After processing all pending migrations, update `~/.donna/state.md` with the Write tool: remove the completed entries from `pending_migrations`. If no entries remain, write:
+```markdown
+---
+pending_migrations: []
+---
+```
+</step>
+
+<step name="detect-noted-tools">
+Read `<storage_repo>/donna/role.md` and `<storage_repo>/donna/role-research.md` with the Read tool. If either file does not exist, skip reading that file.
+
+Look for lines containing tool names noted by set-role's approve-tools step. These lines follow the pattern `✓ Noted: <ToolName>` or `- Noted: <ToolName>`. Collect the noted tool names as `<noted_tools>`.
+
+If `<noted_tools>` has more than one entry and no specific tool name was provided as argument to the command, offer batch mode via AskUserQuestion:
+
+```
+Set-role noted these tools: <list>. Configure all of them now? (yes/no)
+```
+
+If yes, set batch mode active and process each tool sequentially through steps 4–11 below. If no, proceed to ask-tool-name for a single tool.
+</step>
+
+<step name="ask-tool-name">
+If a tool name was provided as argument (e.g. `/donna:add-tool gh`), use it directly. Otherwise, use AskUserQuestion:
+
+```
+What tool would you like to add? (e.g. gh, jira, kubectl)
+```
+
+Store the answer as `<tool_name>`.
+
+Resolve the CLI command — default to the tool name itself. If the tool name is in `<noted_tools>`, pre-fill any context from set-role notes. Use AskUserQuestion to confirm or override the CLI command:
+
+```
+CLI command for <tool_name>? (default: <tool_name>)
+```
+
+If the user presses enter without typing, use the default. Store the confirmed CLI command as `<command>`.
+</step>
+
+<step name="verify-installation">
+Run via Bash:
+```bash
+which <command> && echo "INSTALLED=true" || echo "INSTALLED=false"
+```
+
+If INSTALLED=false, print:
+```
+! <command> is not installed. You can still save it, but data pulling won't work until you install it.
+```
+Continue (do not stop — user may want to pre-configure).
+
+If INSTALLED=true, run:
+```bash
+<command> --version 2>/dev/null | head -1
+```
+
+Store the output as `<version>`. If the command does not support `--version`, store `<version>` as `unknown`.
+</step>
+
+<step name="auth-test">
+For well-known tools, run the appropriate auth test via Bash with a 10-second timeout:
+
+- `gh`: `timeout 10 gh api user --jq '.login' 2>&1`
+- `jira`: `timeout 10 jira me 2>&1`
+- `kubectl`: `timeout 10 kubectl auth whoami 2>&1`
+- Other tools: skip auth test, print `ℹ No known auth test for <command>. Verify manually.`
+
+On success (exit 0): print `✓ Authenticated as <output>`.
+
+On failure (non-zero exit): print `! Authentication failed for <command>. Fix: <tool-specific fix instructions>`.
+
+Fix instructions per tool:
+- `gh` → run `gh auth login`
+- `jira` → run `jira init`
+- `kubectl` → check your kubeconfig
+
+Continue (do not stop — user may want to save the tool despite auth issues).
+</step>
+
+<step name="ask-scope">
+Ask the user to define the scope/context for this tool. Different tools need different scope:
+
+- **gh**: Which GitHub orgs or repos to pull from (e.g., `mycompany`, `mycompany/api mycompany/web`)
+- **jira**: Which Jira project(s) or board(s) (e.g., `AUTH`, `AUTH PLAT`)
+- **kubectl**: Which namespace(s) or cluster(s) (e.g., `production`, `staging production`)
+- **Other tools**: Any relevant filtering context
+
+Use AskUserQuestion:
+```
+What scope should Donna use for <tool_name>?
+(e.g., for gh: which orgs/repos; for jira: which projects)
+Leave blank for no filtering.
+```
+
+Store the answer as `<scope>`. If blank, set to empty string.
+</step>
+
+<step name="learn-capabilities">
+Determine if the tool is well-known (gh, jira, kubectl) or unknown. For well-known tools, synthesize capabilities from training data. Do NOT parse --help for well-known tools.
+
+**gh (GitHub CLI) — training data baseline:**
+
+If `<scope>` is set, add `--owner=<org>` to each search command for each org in scope (space-separated). If scope contains specific repos (format `owner/repo`), use `--repo=<owner/repo>` instead. If scope is empty, do not add owner/repo filters.
+
+- list-assigned-prs: `gh search prs --assignee=@me --state=open --json number,title,url --limit 20`
+- list-review-requests: `gh search prs --review-requested=@me --state=open --json number,title,url --limit 20`
+- list-assigned-issues: `gh search issues --assignee=@me --state=open --json number,title,url --limit 20`
+
+**jira (ankitpokhrel/jira-cli) — training data baseline:**
+
+If `<scope>` is set, add `-p<project>` to each command for each project in scope (space-separated). If scope is empty, do not add project filters.
+
+- list-sprint-issues: `jira sprint list --current -a$(jira me) --plain`
+- list-my-issues: `jira issue list -a$(jira me) --plain`
+
+**kubectl — training data baseline:**
+
+If `<scope>` is set, replace `--all-namespaces` with `-n <namespace>` for each namespace in scope. If scope is empty, keep `--all-namespaces`.
+
+- list-pods: `kubectl get pods --all-namespaces --field-selector=status.phase!=Succeeded -o wide`
+- list-failing: `kubectl get pods --all-namespaces --field-selector=status.phase=Failed -o wide`
+
+For **unknown tools**, run `<command> --help 2>&1 | head -80` via Bash and use Claude's understanding to identify 3–5 capabilities relevant to daily task management. If `<scope>` is set, incorporate the scope into the CLI invocations where appropriate. Format each as `name: <cli invocation>`.
+
+Store the full list as `<available_capabilities>`.
+</step>
+
+<step name="select-capabilities">
+Present `<available_capabilities>` to the user via AskUserQuestion with multi-select. All capabilities are checked by default. The question text:
+
+```
+Which capabilities should Donna use for <tool_name>? (deselect any you don't want, or type additional ones)
+```
+
+If the user types additional capabilities as free text, parse them into the same `name: command` format.
+
+Store the final selections as `<selected_capabilities>`.
+</step>
+
+<step name="write-tools-md">
+Read `<storage_repo>/donna/tools.md` with the Read tool. If the file does not exist, create it with:
+```markdown
+---
+# tools.md — managed by donna:add-tool
+---
+```
+
+Upsert (not overwrite) the tool's section. Each tool section has this format:
+```markdown
+## <tool_name>
+
+- command: <command>
+- version: <version>
+- learned: <today's date YYYY-MM-DD>
+- auth_test: <auth_test_command or "none">
+- scope: <scope or "none">
+
+### Capabilities
+- <capability_name>: <cli_invocation>
+```
+
+If a section for this tool already exists in tools.md, replace it entirely. Write the full file back with the Write tool. Preserve all other tool sections unchanged.
+</step>
+
+<step name="git-commit">
+Run via Bash:
+```bash
+git -C <storage_repo> add -A
+```
+
+Check whether there is anything to commit:
+```bash
+git -C <storage_repo> status --porcelain
+```
+
+If the output is empty, skip the commit and continue.
+
+Otherwise, run:
+```bash
+git -C <storage_repo> commit -m "donna(add-tool): added <tool_name>"
+```
+
+If `auto_push` is true in config, also run:
+```bash
+git -C <storage_repo> push
+```
+</step>
+
+<step name="confirm">
+Print:
+```
+✓ Added <tool_name> to tools registry
+  Command: <command>
+  Version: <version>
+  Capabilities: <count> configured
+
+  Run /donna:begin-the-day to see tool data in your daily brief.
+```
+
+If in batch mode, repeat steps ask-tool-name through confirm for each remaining tool in `<noted_tools>`, then print a final summary:
+```
+✓ Configured <N> tools: <tool_name_1>, <tool_name_2>, ...
+```
+</step>