devdaily-ai 0.1.2 → 0.3.0

package/README.md

@@ -35,10 +35,15 @@ As developers, we spend too much time on repetitive tasks:
 | **🚀 Standup Generator**     | Generate daily standup notes from recent commits in 30 seconds       |
 | **📄 Smart PR Descriptions** | Auto-generate PR titles and descriptions with commitlint integration |
 | **📅 Weekly Summaries**      | Track your impact and accomplishments over time                      |
+| **🎫 GitHub Issues Context** | Fetches linked issues for richer, context-aware AI summaries         |
+| **🖥️ Interactive Dashboard** | Beautiful TUI with keyboard navigation and real-time stats           |
+| **🩺 Doctor Command**        | Diagnose and auto-fix setup issues with `devdaily doctor --fix`      |
+| **⚙️ Customizable Config**   | Per-project and global configuration with themes                     |
+| **⌨️ Shell Integration**     | `dd` alias, tab completions for bash/zsh/fish                        |
 | **🔄 Interactive Workflow**  | Preview, edit, and create PRs with interactive menus                 |
 | **📋 Auto-Copy**             | All outputs copied to clipboard automatically                        |
-| **🎨 Professional Output**   | Clean terminal UI with no emojis (terminal.shop inspired)            |
-| **🔧 Multi-Format**          | Export to Markdown, Slack, or plain text                             |
+| **🎨 Professional Output**   | Clean terminal UI with ASCII art and beautiful formatting            |
+| **🔧 Multi-Format**          | Export to Markdown, Slack, JSON, or plain text                       |
 
 ## Installation
 
@@ -48,7 +53,26 @@ As developers, we spend too much time on repetitive tasks:
 - Git repository
 - GitHub CLI with Copilot extension
 
-### 1. Install GitHub CLI (if not already installed)
+### Quick Install (Recommended)
+
+```bash
+# Install DevDaily
+npm install -g devdaily-ai
+
+# Run doctor to check/fix prerequisites
+devdaily doctor --fix
+
+# Set up shell alias and completions
+devdaily init
+```
+
+That's it! Now you can use `dd` as a shortcut anywhere.
+
+### Manual Setup
+
+If you prefer to set up manually:
+
+#### 1. Install GitHub CLI (if not already installed)
 
 ```bash
 # macOS
@@ -64,14 +88,14 @@ sudo dnf install gh  # Fedora/RHEL
 
 Or visit [cli.github.com](https://cli.github.com) for other installation methods.
 
-### 2. Install GitHub Copilot CLI Extension
+#### 2. Install GitHub Copilot CLI Extension
 
 ```bash
 gh extension install github/gh-copilot
 gh auth login
 ```
 
-### 3. Install DevDaily AI
+#### 3. Install DevDaily AI
 
 ```bash
 npm install -g devdaily-ai
@@ -80,6 +104,10 @@ npm install -g devdaily-ai
 ### Verify Installation
 
 ```bash
+# Check everything is set up correctly
+devdaily doctor
+
+# Or manually check version
 devdaily --version
 devdaily --help
 ```
@@ -89,14 +117,20 @@ devdaily --help
 Navigate to any git repository and run:
 
 ```bash
+# First time setup (sets up 'dd' alias and shell completions)
+devdaily init
+
 # Generate standup notes
-devdaily standup
+devdaily standup   # or: dd s
 
 # Generate PR description
-devdaily pr
+devdaily pr        # or: dd p
 
 # Get weekly summary
-devdaily week
+devdaily week      # or: dd w
+
+# Open interactive dashboard
+devdaily dash      # or: dd d
 ```
 
 All outputs are automatically copied to your clipboard! 📋
@@ -209,6 +243,223 @@ Recover work context from past commits (coming soon).
 devdaily context --days=7
 ```
 
+### `devdaily dash`
+
+Open the interactive dashboard with keyboard navigation.
+
+```bash
+# Open dashboard
+devdaily dash
+
+# Short alias
+dd d
+```
+
+**Keyboard Shortcuts:**
+
+- `s` - Generate standup
+- `p` - Generate PR description
+- `w` - Generate weekly summary
+- `c` - Open configuration
+- `r` - Refresh data
+- `q` - Quit
+
+### `devdaily init`
+
+Set up DevDaily with shell aliases and completions.
+
+```bash
+# Interactive setup
+devdaily init
+
+# Global setup (for all projects)
+devdaily init --global
+
+# Only set up alias
+devdaily init --alias
+
+# Only set up completions
+devdaily init --completions
+```
+
+**Sets up:**
+
+- Shell alias: `dd` → `devdaily`
+- Tab completions for bash/zsh/fish
+- Configuration file
+
+### `devdaily config`
+
+Manage DevDaily configuration.
+
+```bash
+# Interactive config editor
+devdaily config
+
+# Open config in your editor
+devdaily config --edit
+
+# Show current config
+devdaily config --show
+
+# Show config file path
+devdaily config --path
+
+# Reset to defaults
+devdaily config --reset
+```
+
+### `devdaily doctor`
+
+Check system requirements and diagnose issues.
+
+```bash
+# Check all prerequisites
+devdaily doctor
+
+# Attempt automatic fixes
+devdaily doctor --fix
+
+# Short alias
+devdaily check
+```
+
+**Checks:**
+
+- ✅ Node.js version (>= 18)
+- ✅ Git installed
+- ✅ GitHub CLI installed
+- ✅ GitHub authentication
+- ✅ Copilot extension installed
+
+**Auto-fix capabilities:**
+
+- Interactive GitHub authentication
+- Copilot extension installation
+
+## GitHub Issues Integration
+
+DevDaily automatically fetches GitHub issue context to provide **richer, more meaningful summaries**. When your commits reference issues (e.g., `fix #123`), DevDaily:
+
+1. Fetches the issue title and description
+2. Categorizes it (bug, feature, docs, etc.)
+3. Includes the context in AI prompts for better summaries
+
+**Benefits:**
+
+- PR descriptions explain the _why_ (business value), not just the _what_
+- Weekly summaries highlight impact by referencing completed issues
+- Standup notes include context about what you were working on
+
+**Usage:**
+
+```bash
+# Normal usage (issues fetched automatically)
+devdaily standup
+
+# Skip issue fetching (faster, offline)
+devdaily standup --no-issues
+devdaily pr --no-issues
+devdaily week --no-issues
+```
+
+## Configuration
+
+DevDaily supports both global and per-project configuration.
+
+### Config File Locations
+
+- **Global:** `~/.config/devdaily/config.json`
+- **Local:** `.devdailyrc` in your project root
+
+### Example Configuration
+
+```json
+{
+  "version": 1,
+  "theme": {
+    "primary": "cyan",
+    "accent": "magenta"
+  },
+  "ascii": true,
+  "compactMode": false,
+  "output": {
+    "format": "markdown",
+    "copyToClipboard": true,
+    "showStats": true
+  },
+  "projectManagement": {
+    "tool": "github",
+    "ticketPrefix": "PROJ"
+  },
+  "standup": {
+    "defaultDays": 1
+  },
+  "pr": {
+    "defaultBase": "main"
+  },
+  "week": {
+    "startDay": "monday"
+  }
+}
+```
+
+### Project Management Integration
+
+DevDaily supports multiple project management tools for richer context:
+
+```json
+{
+  "projectManagement": {
+    // Tool: "github" | "jira" | "linear" | "notion" | "none"
+    "tool": "jira",
+
+    // Ticket prefix for extraction from branches/commits
+    "ticketPrefix": "PROJ",
+
+    // Jira settings
+    "jira": {
+      "baseUrl": "https://yourcompany.atlassian.net",
+      "projectKey": "PROJ"
+    },
+
+    // Linear settings
+    "linear": {
+      "teamKey": "ENG"
+    },
+
+    // Notion settings
+    "notion": {
+      "databaseId": "your-database-id"
+    }
+  }
+}
+```
+
+**Environment Variables for Authentication:**
+
+```bash
+# Jira
+export JIRA_BASE_URL="https://yourcompany.atlassian.net"
+export JIRA_EMAIL="you@company.com"
+export JIRA_API_TOKEN="your-api-token"
+
+# Linear
+export LINEAR_API_KEY="lin_api_xxx"
+
+# Notion
+export NOTION_API_KEY="secret_xxx"
+export NOTION_DATABASE_ID="xxx"
+```
+
+**Ticket Extraction:**
+
+DevDaily automatically extracts ticket IDs from:
+
+1. **Branch names**: `feature/PROJ-123-description`, `PROJ-123/fix-bug`
+2. **Commit messages**: `fix: resolve issue PROJ-123`
+3. **Manual input**: `devdaily pr --ticket PROJ-123`
+
 ## Examples
 
 See the [`examples/`](examples/) directory for detailed output samples:
@@ -272,22 +523,34 @@ npm run build
 devdaily-ai/
 ├── src/
 │   ├── commands/         # CLI command implementations
-│   │   ├── standup.ts   # Standup generator
-│   │   ├── pr.ts        # PR description generator
-│   │   ├── week.ts      # Weekly summary
-│   │   └── context.ts   # Context recovery
-│   ├── core/            # Core business logic
+│   │   ├── standup.ts    # Standup generator
+│   │   ├── pr.ts         # PR description generator
+│   │   ├── week.ts       # Weekly summary
+│   │   ├── dash.ts       # Interactive dashboard
+│   │   ├── init.ts       # Shell setup (aliases, completions)
+│   │   ├── config.ts     # Configuration management
+│   │   └── context.ts    # Context recovery (coming soon)
+│   ├── core/             # Core business logic
 │   │   ├── git-analyzer.ts    # Git operations
 │   │   └── copilot.ts         # Copilot CLI integration
-│   ├── utils/           # Utilities
-│   │   ├── ui.ts        # Terminal UI helpers
-│   │   ├── helpers.ts   # Date, clipboard utilities
-│   │   └── commitlint.ts      # Commit parser
-│   ├── types/           # TypeScript type definitions
-│   └── index.ts         # CLI entry point
-├── tests/               # Test files
-├── docs/                # Documentation
-├── examples/            # Usage examples
+│   ├── ui/               # Terminal UI system
+│   │   ├── renderer.ts   # Main UI rendering functions
+│   │   ├── colors.ts     # Theme-aware color system
+│   │   ├── ascii.ts      # ASCII art and symbols
+│   │   ├── help.ts       # Beautiful help screens
+│   │   ├── dashboard.ts  # Interactive TUI dashboard
+│   │   └── keyboard.ts   # Keyboard input handling
+│   ├── config/           # Configuration system
+│   │   ├── schema.ts     # Zod config schema
+│   │   └── index.ts      # Config manager
+│   ├── utils/            # Utilities
+│   │   ├── helpers.ts    # Date, clipboard utilities
+│   │   └── commitlint.ts # Commit parser
+│   ├── types/            # TypeScript type definitions
+│   └── index.ts          # CLI entry point
+├── tests/                # Test files
+├── docs/                 # Documentation
+├── examples/             # Usage examples
 └── dist/                # Build output
 ```