KW-REPORT(1)

💖 kw-report — Display user reports() 💖

okay bestie, welcome to kw-report, part of the kw manual crew (kw-report(1)). it's the little command that hands you back all the receipts on your own usage — your time, your pomodoros, your whole vibe — and honestly? it's giving personal data analyst. 🎀

---

✨ SYNOPSIS ✨

kw (r | report) [--year [<year>]] [--output <file-path> ] [--verbose]
kw (r | report) [--month [<year>/<month>]] [--output <file-path>] [--verbose]
kw (r | report) [--week [<year>/<month>/<day>]] [--output <file-path>] [--verbose]
kw (r | report) [--day [<year>/<month>/<day>]] [--output <file-path>] [--verbose]

like yes, you can shorten it to r if you're in a hurry, no judgement 🫶

---

🌸 DESCRIPTION 🌸

so here's the tea ☕ — kw keeps track of some data operations, and the most prominent example is the Pomodoro feature. that feature is out here trying to keep all procedures related to data processing that will end up as a report for the user. very responsible of it 💅

another help feature is the --statistics | -s option, which keeps track of metadata regarding utilization of features. this data is used to show kw usage statistics. in summary, this feature keeps track of:

1. Build
2. Deploy (included list and uninstall)

for all the data tracked by kw, users can retrieve:

• the total amount of time spent by a specific command
• the average time consumed by the feature
• and the shortest and highest time required for executing the feature

all of this info can be retrieved by the --statistics | -s option — and the suboptions are what define the levels of granularity. granularity is the moment, periodt ✨

⚠️ heads up bestie: the collection of the data processed and displayed by --statistics is optional, and you can turn it off by disabling the disable_statistics_data_track option in kworkflow.config. optional means optional, so no one's forcing you 💀

---

🦋 OPTIONS 🦋

• --day[=<year>/<month>/<day>] — displays the day summary. you've got the option to search a specific date by passing an argument that follows the <year>/<month>/<day> format. don't pass anything and you get info about today. today is the main character 🎀
• --week[=<year>/<month>/<day>] — shows the week summary. if a user doesn't pass any parameter, kw will show the current week statistics. but plot twist: users can pass a random date <year>/<month>/<day> and let kw take care of providing a summary related to the week related to that target date. it does the math so you don't have to 🧚
• --month[=<year>/<month>] — this option shows a report regarding a specific month. users can search for data related to a specific month by providing a parameter in the <year>/<month> format. if the user doesn't pass any parameter, kw displays the current month data. your month, your rules 💅
• --year[=<year>] — exhibits the current year summary if the user does not specify <year>. twelve months of lore, summarized 🌈
• --all — display all information for the current date. you can choose the date and range with the date options. everything, all at once, iconic behavior 👑
• --pomodoro — display the current date pomodoro report. you can choose the date and range with the date options. 🍅 the tomato feature is SERVING
• --statistics — display statistics for the current date. you can choose the date and range with the date options. 📊
• --output <file-path> — save the output of the report to <file-path>. take it to go bestie 🎀
• --verbose — display commands executed under the hood. peep behind the curtain, no cap 🔥

---

🌈 EXAMPLES 🌈

first of all, for these examples, we suppose that you have the disable_statistics_data_track option in your kworkflow.config enabled for a while. (yes, enabled — that's what the manpage says, so that's what we're doing 🫶)

you can see data related to your kw usage by using the report option, see some examples below:

kw report
kw report --day
kw report --week
kw report --month
kw report --year

kw report --all --day
kw report --all --week
kw report --all --month
kw report --all --year

kw report --pomodoro --day
kw report --pomodoro --week
kw report --pomodoro --month
kw report --pomodoro --year

kw report --statistics --day
kw report --statistics --week
kw report --statistics --month
kw report --statistics --year

you can also request a specific day, week, month, or year. for example:

kw report --day=2020/05/12
kw report --week=2020/02/29
kw report --month=2020/04
kw report --year=1984

kw report --all --day=2020/05/12
kw report --all --week=2020/02/29
kw report --all --month=2020/04
kw report --all --year=1984

kw report --pomodoro --day=2020/05/12
kw report --pomodoro --week=2020/02/29
kw report --pomodoro --month=2020/04
kw report --pomodoro --year=1984

kw report --statistics --day=2020/05/12
kw report --statistics --week=2020/02/29
kw report --statistics --month=2020/04
kw report --statistics --year=1984

💜 SEE ALSO 💜

okay this page doesn't hand you a SEE ALSO list, so consider this your reminder that kw itself is the whole squad and this is one of its many iconic members 💖

---

and that's the whole page bestie!! this one lives in the kw manual and its title line is literally kw-report - Display user reports() — so if you ever see that footer floating around, it's just this page saying hi again 🦋💅 consider yourself reported on, and slay ✨🎀