Getting started:
npm install -g workbook-hours
(if you don't have npm
, you'll need to install node via brew if you have it or by downloading)
Edit the config file in ~/.workbook/config.json
:
Usage:
Choose from all options with workbook
, or jump straight to one of them:
- Add a timecard:
workbook-log
- Defaults to today. To log time for a different date:
workbook-log YYYY-MM-DD
- If you know the project number, a shortcut is:
workbook-log [project number]
(without the brackets). This option is mutually exclusive with specifying a date.
- Defaults to today. To log time for a different date:
- Edit or clear an existing timecard entry:
workbook-edit
- Defaults to today. To edit or clear an entry for a different date:
workbook-edit YYYY-MM-DD
- Defaults to today. To edit or clear an entry for a different date:
- See and approve daily activity:
workbook-review
- Defaults to today. To review/approve activity for a different date:
workbook-review YYYY-MM-DD
- Defaults to today. To review/approve activity for a different date:
- See timecards for this week:
workbook-timecards
- See your allocation for this week:
workbook-allocation
- See hours allocation for a project:
workbook-hours
- If you know the project number, a shortcut is:
workbook-hours [project number]
(without the brackets)
- If you know the project number, a shortcut is:
Development
Workbook API documentation
Endpoints: https://example.workbook.net/api/metadata
Deployment
Gitlab automatically deploys this project to NPM (https://www.npmjs.com/package/workbook-hours) on tagged commits. Tags should be semantically versioned (MAJOR.minor.patch
). See existing tags at https://gitlab.com/newcity/workbook-hours/-/tags