Projektron-bcs-cli NPM

projektron-bcs-cli

Command line interface (cli) to handle time recordings in Projektron BCS from your terminal - saving time, money and nerves.

Design goals

Providing an intuitive CLI for BCS
Reduce the manual steps for time recording as much as possible

Usage

Requirements

node >= v16.16.0

Getting Started

Simply run the following and follow the instructions:

npm install -g projektron-bcs-cli
bcs

Adding your time recordings to BCS never has been easier 🚀

Commands

Currently, the following commands are supported:

Command	Description
add	Add your time recordings for a specific day (overwrites your previous recordings!).
get	Show your time recordings for a specific day.
reset	Reset your time recordings for a specific date.
check	Show your monthly time balance.
mapping	Customize the task to projectId mapping for your needs!
quit	Quit the cli.

Additional Notes

📢 You may want to use the mapping command to customize the task to projectId mapping for your needs and let the cli do the magic for you.

Hints:

use tab to keep and edit initial values
use ctrl+c to escape from the current prompt and return to beginning

Miscellaneous

🤝 Contributing

Contributions, issues and feature requests are welcome!

Installation from source

Clone this repository and execute the following steps:

cd bcs-cli
npm run build
npm install --location=global .

💻 Development

You may want to create a .env file in the project ,directory with the evironment variables BCS_URL, BCS_USERNAME and BCS_PASSWORD.

To run the application without installing it globally:

cd bcs-cli
npm install

# hot reloading
npm run start:dev

# build and run
npm run build
npm run start

# test
 npm run test
 
 # install global
 npm run build
 npm install -g projektron-bcs-cli .