https://github.com/pgebert/projektron-bcs-cli
CLI for Projektron BCS software to make time recording more efficient and convenient. 🧙♂️
https://github.com/pgebert/projektron-bcs-cli
bcs cli projektron projektron-bcs
Last synced: 11 months ago
JSON representation
CLI for Projektron BCS software to make time recording more efficient and convenient. 🧙♂️
- Host: GitHub
- URL: https://github.com/pgebert/projektron-bcs-cli
- Owner: pgebert
- License: apache-2.0
- Created: 2023-07-02T19:30:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-05T09:08:24.000Z (about 1 year ago)
- Last Synced: 2025-07-06T12:08:44.492Z (11 months ago)
- Topics: bcs, cli, projektron, projektron-bcs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/projektron-bcs-cli
- Size: 1.54 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
projektron-bcs-cli
# Design goals
1. Providing an intuitive CLI for BCS
2. 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:
```shell
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](https://github.com/pgebert/bcs-cli/issues) and feature requests are welcome!
## Installation from source
Clone this repository and execute the following steps:
```shell
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:
```shell
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 .
```
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2023 [pgebert](https://github.com/pgebert).
This project is licensed under [Apache 2.0](LICENSE).