A small utility for generating weekly reports from Linear.
This script generates a report of the user's active projects, completed tasks in the past week, and upcoming tasks for the next week using the Linear API. The report is saved in both Markdown and HTML formats.
- Clone the repository
- Run
npm install
to install dependencies - Create a Linear API key here
- Copy
.env.example
to.env
and fill in the values with your Linear API key, as well as flip theSAVE_TO_DESKTOP
flag to true if you want to save the report to your desktop
- Run
npm run start
to start the script - The script will fetch data from Linear API and generate a weekly report
- The report will be saved in the
reports
folder on your desktop (or in the current directory) in both Markdown (report.md) and HTML (report.html) formats - Insert the report into your email and send!
Example output can be found here.