workbook-hours

2.6.1 • Public • Published

Current NPM version

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:

{
    "workbook": "example.workbook.net",
    "username": "user@example.com",
    "password": "xxxxxxxxxx"
}

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.
  • 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
  • See and approve daily activity: workbook-review
    • Defaults to today. To review/approve activity for a different date: workbook-review YYYY-MM-DD
  • 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)

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

Readme

Keywords

none

Package Sidebar

Install

npm i workbook-hours

Weekly Downloads

1

Version

2.6.1

License

ISC

Unpacked Size

47.7 kB

Total Files

33

Last publish

Collaborators

  • ahebrank