npm - devdaily-ai - Versions diffs - 0.4.0 → 0.6.0 - Mend

devdaily-ai 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "devdaily-ai",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Your AI memory for developer work - auto-generate PR descriptions, standup notes, and work summaries",
   "type": "module",
   "bin": {
@@ -24,13 +24,16 @@
   "keywords": [
     "cli",
     "git",
-    "pr",
     "standup",
+    "pr",
+    "weekly-summary",
     "copilot",
     "ai",
-    "developer-tools"
+    "developer-tools",
+    "productivity",
+    "devtools"
   ],
-  "author": "",
+  "author": "Hem Pun <https://github.com/hempun10>",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,7 +46,9 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md",
+    "CONTRIBUTING.md"
   ],
   "dependencies": {
     "boxen": "^8.0.1",

package/README.md.bak DELETED Viewed

@@ -1,595 +0,0 @@
-<div align="center">
-# DevDaily AI
-**Your AI-powered developer memory**
-Auto-generate standup notes, PR descriptions, and weekly summaries from your git history.
-[![NPM Version](https://img.shields.io/npm/v/devdaily-ai)](https://www.npmjs.com/package/devdaily-ai)
-[![Node Version](https://img.shields.io/node/v/devdaily-ai)](https://nodejs.org)
-[![License](https://img.shields.io/npm/l/devdaily-ai)](LICENSE)
-[![GitHub Stars](https://img.shields.io/github/stars/hempun10/devdaily)](https://github.com/hempun10/devdaily)
-[Installation](#installation) • [Quick Start](#quick-start) • [Commands](#commands) • [Examples](#examples) • [Contributing](docs/CONTRIBUTING.md)
-</div>
----
-## Why DevDaily AI?
-As developers, we spend too much time on repetitive tasks:
-- ⏱️ Writing standup notes every morning
-- 📝 Crafting PR descriptions from scratch
-- 📊 Summarizing weekly accomplishments
-- 🔍 Remembering what we were working on last week
-**DevDaily AI solves this.** It analyzes your git history and uses GitHub Copilot CLI to generate professional summaries in seconds.
-## Features
-| Feature                      | Description                                                          |
-| ---------------------------- | -------------------------------------------------------------------- |
-| **🚀 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                      |
-| **�️ Interactive Dashboard** | Beautiful TUI with keyboard navigation and real-time stats          |
-| **⚙️ 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 ASCII art and beautiful formatting            |
-| **🔧 Multi-Format**          | Export to Markdown, Slack, JSON, or plain text                       |
-## Installation
-**Prerequisites:**
-- Node.js >= 18.0.0
-- Git repository
-- GitHub CLI with Copilot extension
-### 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
-brew install gh
-# Windows
-winget install --id GitHub.cli
-# Linux
-sudo apt install gh  # Debian/Ubuntu
-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
-```bash
-gh extension install github/gh-copilot
-gh auth login
-```
-#### 3. Install DevDaily AI
-```bash
-npm install -g devdaily-ai
-```
-### Verify Installation
-```bash
-# Check everything is set up correctly
-devdaily doctor
-# Or manually check version
-devdaily --version
-devdaily --help
-```
-## Quick Start
-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   # or: dd s
-# Generate PR description
-devdaily pr        # or: dd p
-# Get weekly summary
-devdaily week      # or: dd w
-# Open interactive dashboard
-devdaily dash      # or: dd d
-```
-All outputs are automatically copied to your clipboard! 📋
-## Commands
-### `devdaily standup`
-Generate daily standup notes from your recent commits.
-```bash
-# Yesterday's work (default)
-devdaily standup
-# Last 3 days
-devdaily standup --days=3
-# Last week
-devdaily standup --days=7
-# Output in Slack format
-devdaily standup --format=slack
-# Plain text format
-devdaily standup --format=plain
-# Don't copy to clipboard
-devdaily standup --no-copy
-```
-**Options:**
-- `--days, -d <number>` - Number of days to analyze (default: 1)
-- `--format, -f <format>` - Output format: markdown, slack, plain (default: markdown)
-- `--no-copy` - Don't copy to clipboard
-### `devdaily pr`
-Generate comprehensive PR descriptions with smart title generation.
-```bash
-# Generate PR description (interactive)
-devdaily pr
-# Create PR immediately
-devdaily pr --create
-# Create draft PR
-devdaily pr --draft
-# Compare to develop branch
-devdaily pr --base=develop
-# Don't copy to clipboard
-devdaily pr --no-copy
-```
-**Options:**
-- `--base, -b <branch>` - Base branch to compare against (default: main)
-- `--create, -c` - Create PR on GitHub immediately
-- `--draft, -d` - Create PR as draft
-- `--no-copy` - Don't copy to clipboard
-**Interactive Menu:**
-When you run `devdaily pr` without flags, you get an interactive menu:
-- 👁️ Preview in terminal
-- 📋 Copy to clipboard
-- 🚀 Create PR on GitHub
-- 📝 Create draft PR
-- ❌ Cancel
-**Smart Features:**
-- Automatically generates PR title from conventional commits
-- Extracts issue numbers (e.g., "Closes #123")
-- Categorizes PR type (feature, bugfix, breaking change)
-- Parses commitlint messages for better titles
-### `devdaily week`
-Generate weekly summary of your accomplishments.
-```bash
-# Current week (default)
-devdaily week
-# Last week
-devdaily week --last
-# Custom start date
-devdaily week --start="2026-02-01"
-# Don't copy to clipboard
-devdaily week --no-copy
-```
-**Options:**
-- `--last, -l` - Show last week instead of current week
-- `--start, -s <date>` - Custom start date (YYYY-MM-DD)
-- `--no-copy` - Don't copy to clipboard
-### `devdaily context`
-Recover work context from past commits (coming soon).
-```bash
-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
-  },
-  "standup": {
-    "defaultDays": 1
-  },
-  "pr": {
-    "defaultBase": "main"
-  },
-  "week": {
-    "startDay": "monday"
-  }
-}
-```
-## Examples
-See the [`examples/`](examples/) directory for detailed output samples:
-- [Standup Output](examples/standup-output.md)
-- [PR Description Output](examples/pr-output.md)
-- [Weekly Summary Output](examples/week-output.md)
-## How It Works
-1. **Analyzes Git History** - Uses `simple-git` to parse commits, diffs, and file changes
-2. **Extracts Context** - Parses conventional commits, issue numbers, and PR types
-3. **AI Summarization** - Leverages GitHub Copilot CLI to generate human-readable summaries
-4. **Professional Output** - Formats with clean terminal UI (chalk, boxen, ora)
-5. **Auto-Copy** - Copies results to clipboard for immediate use
-## Configuration
-DevDaily AI works out of the box with sensible defaults. No configuration file needed!
-All settings can be controlled via command-line flags.
-## Development
-Want to contribute? See our [Contributing Guide](docs/CONTRIBUTING.md).
-```bash
-# Clone the repository
-git clone https://github.com/hempun10/devdaily.git
-cd devdaily
-# Install dependencies
-npm install
-# Run in development mode
-npm run dev
-# Run tests
-npm test
-# Run tests in watch mode
-npm test -- --watch
-# Type checking
-npm run typecheck
-# Lint code
-npm run lint
-npm run lint:fix
-# Format code
-npm run format
-# Build for production
-npm run build
-```
-### Project Structure
-```
-devdaily-ai/
-├── src/
-│   ├── commands/         # CLI command implementations
-│   │   ├── 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
-│   ├── 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
-```
-## Tech Stack
-- **TypeScript** - Type-safe development
-- **Commander.js** - CLI framework
-- **simple-git** - Git operations
-- **execa** - Subprocess execution for Copilot CLI
-- **inquirer** - Interactive prompts
-- **chalk** - Terminal styling
-- **boxen** - Terminal boxes
-- **ora** - Loading spinners
-- **clipboardy** - Clipboard operations
-## FAQ
-**Q: Does this work offline?**
-A: No, DevDaily AI requires GitHub Copilot CLI which needs an internet connection for AI summaries.
-**Q: What git hosting providers are supported?**
-A: DevDaily AI works with any git repository. GitHub CLI is only needed for creating PRs.
-**Q: Is my code sent to GitHub?**
-A: Only commit messages and diffs are sent to GitHub Copilot CLI for summarization. Full file contents are not shared.
-**Q: Can I customize the output format?**
-A: Yes! Use `--format` flag for standup command. PR and weekly commands support markdown by default.
-**Q: Does it work with monorepos?**
-A: Yes! DevDaily AI analyzes the entire git history of your current directory.
-**Q: What about conventional commits?**
-A: DevDaily AI parses conventional commits automatically and uses them for smart PR title generation.
-## Troubleshooting
-### Command not found: devdaily
-Make sure you installed globally:
-```bash
-npm install -g devdaily-ai
-```
-### GitHub Copilot CLI not found
-Install the Copilot extension:
-```bash
-gh extension install github/gh-copilot
-```
-### Not in a git repository
-DevDaily AI only works inside git repositories. Run:
-```bash
-git init  # Initialize a new repo
-# or
-cd /path/to/your/git/repo
-```
-### No commits found
-Make sure you have commits in your repository:
-```bash
-git log  # Check commit history
-```
-For more help, see our [documentation](docs/) or [open an issue](https://github.com/hempun10/devdaily/issues).
-## Roadmap
-- [ ] Support for Ollama (local AI models)
-- [ ] Analytics and tracking dashboard
-- [ ] Context recovery with AI-powered reminders
-- [ ] PR template detection and auto-fill
-- [ ] Integration with Jira/Linear/Asana
-- [ ] Team collaboration features
-- [ ] VS Code extension
-## Contributing
-We welcome contributions! See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for guidelines.
-## License
-MIT © [Hem Pun](https://github.com/hempun10)
-## Acknowledgments
-Built for the [GitHub Copilot CLI Challenge](https://dev.to/devteam/join-the-github-copilot-cli-challenge-win-github-universe-tickets-copilot-pro-subscriptions-and-50af).
-Special thanks to:
-- GitHub Copilot CLI team
-- terminal.shop for UI inspiration
-- The awesome TypeScript community
----
-<div align="center">
-**[⬆ back to top](#devdaily-ai)**
-Made with ❤️ by developers, for developers
-</div>