@hasna/todos 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,149 @@
+# @hasna/todos
+
+Universal task management for AI coding agents. CLI + MCP server + web dashboard + library, all sharing a single SQLite database.
+
+## Features
+
+- **CLI** with interactive TUI (React/Ink) and JSON output
+- **MCP server** for Claude, Codex, Gemini, and any MCP-compatible agent
+- **Web dashboard** with React/shadcn UI, dark mode, and real-time task management
+- **Library** for programmatic access from Node.js/Bun
+- **SQLite** with WAL mode, optimistic locking, and automatic migrations
+- Task dependencies with cycle detection
+- Exclusive agent locking with auto-expiry
+- Full-text search across tasks
+- Project auto-detection from git repositories
+- Subtask hierarchies with cascade deletion
+
+## Installation
+
+```bash
+bun add -g @hasna/todos
+```
+
+## Quick Start
+
+```bash
+# Create a task
+todos add "Fix login bug" --priority high --tags bug,auth
+
+# List tasks
+todos list
+
+# Start working on a task
+todos start <id>
+
+# Mark complete
+todos done <id>
+
+# Launch interactive TUI
+todos
+
+# Start web dashboard
+todos serve
+
+# Register MCP server with AI agents
+todos mcp --register all
+```
+
+## Web Dashboard
+
+Start the dashboard with:
+
+```bash
+todos serve                # http://localhost:19420
+todos serve -p 3000        # Custom port
+todos serve --no-open      # Don't auto-open browser
+```
+
+Features: stats overview, sortable/filterable task table, create/edit/delete tasks, task detail with comments, dark mode toggle.
+
+## MCP Server
+
+Register with your AI coding agents:
+
+```bash
+todos mcp --register claude    # Claude Code
+todos mcp --register codex     # Codex CLI
+todos mcp --register gemini    # Gemini CLI
+todos mcp --register all       # All agents
+```
+
+Or start manually via stdio:
+
+```bash
+todos-mcp
+```
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `todos add <title>` | Create a task |
+| `todos list` | List tasks (active by default) |
+| `todos show <id>` | Show full task details |
+| `todos update <id>` | Update task fields |
+| `todos start <id>` | Claim and start a task |
+| `todos done <id>` | Mark task completed |
+| `todos delete <id>` | Delete a task |
+| `todos plan <title>` | Create a plan with subtasks |
+| `todos comment <id> <text>` | Add a comment |
+| `todos search <query>` | Search tasks |
+| `todos deps <id>` | Manage dependencies |
+| `todos projects` | List/manage projects |
+| `todos export` | Export tasks (JSON or Markdown) |
+| `todos serve` | Start web dashboard |
+| `todos mcp` | Start MCP server |
+
+Use `--json` for JSON output on any command. Use `--agent <name>` to identify the calling agent.
+
+## Library Usage
+
+```typescript
+import { createTask, listTasks, completeTask } from "@hasna/todos";
+
+const task = createTask({ title: "My task", priority: "high" });
+const tasks = listTasks({ status: "pending" });
+completeTask(task.id);
+```
+
+## Database
+
+SQLite database with automatic location detection:
+
+1. `TODOS_DB_PATH` environment variable (`:memory:` for testing)
+2. `.todos/todos.db` in current directory
+3. `~/.todos/todos.db` global fallback
+
+## Development
+
+```bash
+git clone https://github.com/hasna/todos.git
+cd todos
+bun install
+bun test                    # Run 112 tests
+bun run typecheck           # TypeScript checking
+bun run dev:cli             # Run CLI in dev mode
+bun run build:dashboard     # Build web dashboard
+```
+
+## Architecture
+
+```
+src/
+  types/     TypeScript types, enums, custom errors
+  db/        SQLite data layer (tasks, projects, comments, sessions)
+  lib/       Business logic (search)
+  cli/       Commander.js CLI + React/Ink TUI
+  mcp/       MCP server (stdio transport)
+  server/    Bun.serve() HTTP server + REST API
+  index.ts   Library re-exports
+
+dashboard/   Vite + React 19 + Tailwind 4 + shadcn web UI
+```
+
+All surfaces (CLI, MCP, dashboard, library) call directly into `src/db/` — no intermediate service layer.
+
+## License
+
+[Apache License 2.0](LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hasna/todos",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Universal task management for AI coding agents - CLI + MCP server + interactive TUI",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,9 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "LICENSE",
+    "README.md"
   ],
   "scripts": {
     "build": "bun build src/cli/index.tsx --outdir dist/cli --target bun --external ink --external react --external chalk --external @modelcontextprotocol/sdk && bun build src/mcp/index.ts --outdir dist/mcp --target bun --external @modelcontextprotocol/sdk && bun build src/index.ts --outdir dist --target bun && cp src/types/index.ts dist/index.d.ts",