vkomanchy
/
workhours-bot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Bot that count working hours
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
35 Commits
4 Branches
0 Tags
1.1 MiB
 
Tag: Branch: Tree: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Go to file
Vladislav Komanchy c23effb7dc
feat: chunk report to messages 		2 months ago
commands feat: chunk report to messages 2 months ago
database feat: add today worklogs notification for users with enabled notifications 3 months ago
.env.example feat: first version 3 years ago
.gitignore feat: add possibility to set worklog as paid 3 months ago
README.md feat: update README.md 3 months ago
app.ts feat: chunk report to messages 2 months ago
appRegExps.ts feat: add help in bot commands 3 months ago
commands-showcase.png feat: update README.md 3 months ago
getWorklogsAndDateForRange.ts feat: split app to commands by their purpose 3 months ago
isValidTimezone.ts feat: add possibility to set timeZone for user through input or user location 3 months ago
nodemon.json feat: first version 3 years ago
package-lock.json feat: add today worklogs notification for users with enabled notifications 3 months ago
package.json feat: add today worklogs notification for users with enabled notifications 3 months ago
tsconfig.json feat: first version 3 years ago
tslint.json feat: first version 3 years ago
types.ts feat: add basic version of getting worklogs by custom range 3 months ago

README.md

workhours-bot

Telegram bot for logging time and getting reports about logged time. Created with node-telegram-bot-api

Bot id in Telegram: @WorkhoursCountBot

All interaction with bot could be maked only through Telegram.

Registration

To start bot just write /start command in bot. This will create new user.

Quick usage of commands

For quick usage of commands now all commands added in bot commands.

Commands in Telegram bot

Bot settings

Command Description Example
/set_rate Set rate of user in $. /set_rate 15
/set_timezone Set timezone. Timezone should be in IANA format. /set_timezone Europe/Moscow
/get_timezone_by_location Return keyboard with location request. Available only for mobile devices. /get_timezone_by_location

Worklog commands

Command Description Example
/start_timer Create worklog with description, tags (#) and $paid param (show is worklog will be calculated as paid) /start_timer Worklog description #MyProject $paid
/stop_timer Set stopped time to current second for worklog. If id specified will stop this worklog, otherwise will stop previously started worklog /stop_timer 9245fd3b-dcea-4696-8d89-7dfffc355fd2
/delete_worklog Delete worklog /delete_worklog 9245fd3b-dcea-4696-8d89-7dfffc355fd2
/edit_worklog Edit worklog. Works the same as start, but id should be defined by user /edit_worklog id=2d57c03d-ed16-4688-bad3-a3c93584e08c $paid New description
/create_worklog Create worklog. Works the same as start, but logged should be defined by user in seconds. /create_worklog Worklog description $paid #TM logged=500

Worklog reports

Command Description Example
/today_worklogs Get worklogs for today /today_worklogs
/yesterday_worklogs Get worklogs for yesterday /yesterday_worklogs
/week_worklogs Get worklogs for current week /week_worklogs
/prev_week_worklogs Get worklogs for previous week /prev_week_worklogs
/month_worklogs Get worklogs for current month /month_worklogs
/prev_month_worklogs Get worklogs for previous month /prev_month_worklogs
/get_worklogs_by_dates Get worklogs for dates from start to end. start and end should be Unix time /get_worklogs_by_dates start=1653414914790 end=1653414914790