Skip to content

a command-line tool that generates automated individual activity reports from ClickUp tasks and Github

License

Notifications You must be signed in to change notification settings

Afrawles/devreport

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

devreport

Go License: MIT

DevReport is a command-line tool that generates automated individual activity reports from ClickUp tasks. It pulls tasks, computes stats (total, completed, by status/source/type), and renders beautiful HTML/PDF reports with summaries and detailed tables.

Features

  • One-command reports: Fetch from ClickUp → Generate HTML/PDF + JSON export
  • Smart stats: Auto-calculates totals, completion rates, breakdowns by status/source/type
  • Cross-platform: Pre-built binaries for macOS, Linux, Windows (AMD64/ARM64)
  • Optional AI Rephrasing: Integrates with Ollama for task rewording

Prerequisites

  • ClickUp Account: Access to tasks via API
  • Terminal: sh/Zsh/PowerShell
  • Optional: Browser to view HTML reports
  • Optional: Ollama running locally (port 11434) for AI rephrasing

Installing Ollama and Gemma3 on linux

  1. Install Ollama:

    curl -fsSL https://ollama.com/install.sh | sh
  2. Start Ollama:

    ollama serve
  3. Pull the Gemma3 model:

    ollama pull gemma3
  4. Verify installation:

    curl http://localhost:11434/api/tags

Installation

Option 1: Download Pre-built Binary (Recommended)

  1. Go to the Releases page

  2. Download the archive for your platform:

    • macOS Intel: devreport_darwin_amd64.tar.gz
    • macOS Apple Silicon: devreport_darwin_arm64.tar.gz
    • Linux AMD64: devreport_linux_amd64.tar.gz
    • Linux ARM64: devreport_linux_arm64.tar.gz
    • Windows: devreport_windows_amd64.zip
  3. Extract and install (macOS/Linux):

    tar -xzf devreport_darwin_amd64.tar.gz chmod +x devreport sudo mv devreport /usr/local/bin/
  4. Verify installation:

    devreport --help

Option 2: Build from Source

git clone https://github.com/Afrawles/devreport.git cd devreport go build -o devreport ./cmd/devreport ./devreport --help

Getting Your ClickUp API Token

  1. Log in to ClickUp
  2. Click your profile picture → Settings
  3. Go to AppsAPI Token
  4. Click Generate and copy your token
  5. Use it with the --clickup-token flag

Finding Your ClickUp List IDs

  1. In the ClickUp sidebar, hover over a List

  2. Click the ellipsis (...)Copy link

  3. Example:

    https://app.clickup.com/12345678/v/li/987654321
  4. The number after /li/ is your List ID (987654321)

  5. Use commas to separate multiple lists:

    987654321,123456789

Finding Your ClickUp Assignee IDs

curl -H "Authorization: YOUR_API_TOKEN" \ "https://api.clickup.com/api/v2/team"

Usage

When working with multiple ClickUp lists, DevReport maps text by list order.

  • Use commas (,) to separate different lists
  • Use pipes (|) within each list group to separate sentences belonging to that list

Example Layout

--clickup-listid "11111111,33333333" \ --challenges "Delayed client feedback|Unclear UI specifications|Integration issues with payment service, Server maintenance downtime|Third-party API instability|Deployment delays" \ --support-required "Product team review|QA support for test coverage|DevOps for CI/CD automation, Management alignment|Database admin support|Load testing assistance" \ --support-from "Product Management|QA Department|DevOps Team, IT Infrastructure|Backend Team|Project Management Office" \ --follow-up "Conduct sprint retrospective|Optimize frontend performance|Write integration tests, Refactor legacy modules|Enhance documentation|Evaluate monitoring tools"

Explanation:

  • Everything before the first comma (,) belongs to List 11111111
  • Everything after the comma belongs to List 33333333
  • Within each group, | separates sentences for that list

Basic Command

./devreport \ --user "Uzumaki.Gon" \ --start "2025-10-01" \ --end "2025-10-31" \ --author "Killua Uzumaki" \ --period "Month of October" \ --year 2025 \ --category "Improvements, New Features, and Bug Fixes" \ --clickup-token "your_clickup_token_here" \ --clickup-assignees 1234536,1728383 \ --clickup-listid "11111111,33333333" \ --challenges "Delayed client feedback|Unclear UI specifications|Integration issues with payment service, Server maintenance downtime|Third-party API instability|Deployment delays" \ --support-required "Product team review|QA support for test coverage|DevOps for CI/CD automation, Management alignment|Database admin support|Load testing assistance" \ --support-from "Product Management|QA Department|DevOps Team, IT Infrastructure|Backend Team|Project Management Office" \ --follow-up "Conduct sprint retrospective|Optimize frontend performance|Write integration tests, Refactor legacy modules|Enhance documentation|Evaluate monitoring tools"

After execution, open the generated report:

reports/report_Uzumaki.Gon_20251030.html

This file (report export) contains the task summary, categorized sections, and AI-rephrased content (if Ollama is available).

For Operations & Business Teams

devreport summary --period <period> --clickup-token "<token>" --clickup-folderid <folder-id> 

Supported Periods

Period Description Example
today Current day Tasks created today
yesterday Previous day Tasks created yesterday
this-week or thisweek Current week (Mon-Sun) Tasks from Monday to now
last-week or lastweek Previous week (Mon-Sun) Tasks from last Monday to Sunday
this-month or thismonth Current month Tasks from 1st to now
last-month or lastmonth Previous month Tasks from 1st to last day of previous month
all-time or alltime All time All tasks ever created

Examples

# Weekly report devreport summary --period this-week --clickup-token "pk_xxx" --clickup-folderid 123456 # Monthly report devreport summary --period this-month --clickup-token "pk_xxx" --clickup-folderid 123456 # Filter by specific assignees devreport summary --period this-week --clickup-token "pk_xxx" --clickup-folderid 123456 --clickup-assignees "user1,user2" # Use environment variables export CLICKUP_API_KEY="pk_xxx" export CLICKUP_FOLDERID="123456" devreport summary --period this-week

About

a command-line tool that generates automated individual activity reports from ClickUp tasks and Github

Resources

License

Stars

Watchers

Forks

Packages

No packages published