Skip to main content

Description

Generates comprehensive weekly work summaries by analyzing git history, pull requests, tickets, and journal snapshots. Supports both single-project and cross-project summaries. Aliases: w, weekly

Usage

Options

boolean
Generate summary for last week instead of current week
string
Custom start date in YYYY-MM-DD format
string
Start date for custom range (YYYY-MM-DD)
string
End date for custom range (YYYY-MM-DD)
string
Number of weeks ago (e.g., 2 = two weeks back)
boolean
Include all tracked projects from journal (cross-project summary)
string
Filter by specific project identifier
boolean
Skip fetching closed tickets/issues
boolean
Skip fetching PR context
boolean
Skip journal data (use only live git data)
boolean
Skip auto-saving a snapshot to the journal
boolean
Do not copy to clipboard
boolean
Save the generated summary to the journal as an AI summary
boolean
Show the full context and prompt sent to Copilot
boolean
Output only the raw context block (no AI generation)
boolean
Output stats as JSON (no AI generation)

Examples

Current week summary

Last week

Custom date range

Two weeks ago

Cross-project summary

Save to journal

JSON output for processing

Specific project only

Output Sections

Single-Project Mode

  • Accomplishments - Key work completed
  • In Progress - Active work and open PRs
  • Key Metrics - Lines changed, files touched, PRs merged
  • Notable Items - Breaking changes, features, refactors

Cross-Project Mode

  • Week Overview - High-level themes across projects
  • Per-Project Highlights - Summary for each project
  • Cross-Cutting Themes - Patterns across projects
  • This Week in Numbers - Aggregate statistics

Journal Integration

The week command combines:
  1. Live Git Data - Current commits, PRs, and tickets
  2. Journal History - Saved snapshots from previous days
This provides continuity and shows work progression over time.

Configuration

Relevant config settings:
  • git.defaultBranch - Base branch for comparisons
  • week.startDay - Week start day (monday/sunday)
  • output.copyToClipboard - Auto-copy behavior
  • output.showStats - Display statistics

Requirements

  • Git repository (unless using --all-projects)
  • GitHub Copilot CLI (unless using --json or --raw-context)
  • Journal snapshots for historical context (optional)