https://github.com/nfantone/cpho
ContractingPlus Home Office command line tool (https://mycontractingplus.com/)
https://github.com/nfantone/cpho
cli contracting ework js nodejs tool
Last synced: 4 months ago
JSON representation
ContractingPlus Home Office command line tool (https://mycontractingplus.com/)
- Host: GitHub
- URL: https://github.com/nfantone/cpho
- Owner: nfantone
- License: mit
- Created: 2020-06-05T12:19:54.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-07T20:40:12.000Z (over 3 years ago)
- Last Synced: 2025-02-12T20:21:46.799Z (over 1 year ago)
- Topics: cli, contracting, ework, js, nodejs, tool
- Language: JavaScript
- Size: 789 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @nfantone/cpho
> **C**ontracting **P**lus **H**ome **O**ffice command line tool
Reliably upload daily E-Workers allowance to [mycontractingplus.com][contracting-plus] from the comfort of your home.
```sh
# 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`:
```sh
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][nodejs-dowload] for your system.
## Quick guide
```sh
cpho.js
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**.
```sh
./cpho.js upload -u myuser@company.org -p my-password
```
> :bulb: If not provided using `-u` / `-p`, `cpho` will prompt for username and password.
[contracting-plus]: https://mycontractingplus.com
[nodejs-dowload]: https://nodejs.org/en/download/package-manager/