@nfantone/cpho

Contracting Plus Home Office command line tool

Reliably upload daily E-Workers allowance to mycontractingplus.com from the comfort of your home.

# Clone repository
git clone git@github.com:nfantone/cpho.git
cd cpho

# Install dependencies
npm i --production

# Run test command
./bin/cpho.js --version
1.0.0

Alternatively, using npx:

npx https://github.com/nfantone/cpho --version
npx: installed 87 in 7.784s
1.0.0

Requirements

• node 12+
• npm 6+

Follow official Node.js installation instructions for your system.

Quick guide

cpho.js <command>

Commands:
  cpho.js upload  uploads e-workers allowance for all weekdays in a given month + year

Options:
      --help            Show help                                      [boolean]
      --url             Base Contracting Plus URL
                             [string] [default: "https://mycontractingplus.com"]
  -u, --username        Contracting Plus username                       [string]
  -p, --password        Contracting Plus password                       [string]
  -d, --description     Contracting Plus allowance entry description
                                              [string] [default: "Pragmars LLC"]
      --hs, --hours     Contracting Plus allowance entry hours
                                                           [number] [default: 8]
      --min, --minutes  Contracting Plus allowance entry minutes        [number]
  -m, --month           Index of month to upload allowance for (beginning with 0
                        for January to 11 for December)    [number] [default: 8]
  -y, --year            Year to upload allowance for    [number] [default: 2020]
  -t, --throttle        Number of milliseconds to wait between allowance uploads
                                                         [number] [default: 500]
  -x, --exclude         If specified, an allowance will not be uploaded for
                        these working days                 [array] [default: []]
      --version         Show version number                            [boolean]

Usage

• Upload monthly allowance for all weekdays in current month.

./cpho.js upload -u myuser@company.org -p my-password

💡 If not provided using -u / -p, cpho will prompt for username and password.