{"id":24716530,"url":"https://github.com/pgebert/projektron-bcs-cli","last_synced_at":"2025-07-06T12:08:46.523Z","repository":{"id":182883846,"uuid":"661419203","full_name":"pgebert/projektron-bcs-cli","owner":"pgebert","description":"CLI for Projektron BCS software to make time recording more efficient and convenient. 🧙‍♂️","archived":false,"fork":false,"pushed_at":"2025-06-05T09:08:24.000Z","size":1612,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-06T12:08:44.492Z","etag":null,"topics":["bcs","cli","projektron","projektron-bcs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/projektron-bcs-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pgebert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-02T19:30:30.000Z","updated_at":"2025-06-05T09:08:27.000Z","dependencies_parsed_at":"2023-07-22T01:08:24.949Z","dependency_job_id":"7172248a-8d13-465e-a551-806c4b52fd0f","html_url":"https://github.com/pgebert/projektron-bcs-cli","commit_stats":null,"previous_names":["pgebert/bcs-cli","pgebert/projektron-bcs-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pgebert/projektron-bcs-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgebert%2Fprojektron-bcs-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgebert%2Fprojektron-bcs-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgebert%2Fprojektron-bcs-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgebert%2Fprojektron-bcs-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pgebert","download_url":"https://codeload.github.com/pgebert/projektron-bcs-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgebert%2Fprojektron-bcs-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263898013,"owners_count":23526835,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bcs","cli","projektron","projektron-bcs"],"created_at":"2025-01-27T09:12:58.241Z","updated_at":"2025-07-06T12:08:46.504Z","avatar_url":"https://github.com/pgebert.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![projektron-bcs-cli](https://github.com/pgebert/projektron-bcs-cli/assets/6838540/6dca9cef-bc3b-4f55-9b01-f323b2a7db21)\n\n\u003ch1 align=\"center\"\u003eprojektron-bcs-cli\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n \u003cimg alt=\"Static Badge\" src=\"https://img.shields.io/badge/BCS_Version-V21.4-blue\"\u003e\n\u003c/p\n\n\nCommand line interface (cli) to handle time recordings in Projektron BCS from your terminal - saving time, money and\nnerves.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/pgebert/projektron-bcs-cli/assets/6838540/ed9f7559-c5e0-497c-aa15-0491ba400b1c\" width=\"800px\" height=\"auto\" /\u003e\n\u003c/p\u003e\n\n# Design goals\n\n1. Providing an intuitive CLI for BCS\n2. Reduce the manual steps for time recording as much as possible\n\n# Usage\n\n## Requirements\n\n- node \u003e= v16.16.0\n\n## Getting Started\n\nSimply run the following and follow the instructions:\n\n```shell\nnpm install -g projektron-bcs-cli\nbcs\n```\n\nAdding your time recordings to BCS never has been easier 🚀\n\n## Commands\n\nCurrently, the following commands are supported:\n\n| Command | Description                                                                         |\n|---------|-------------------------------------------------------------------------------------|\n| add     | Add your time recordings for a specific day (overwrites your previous recordings!). |\n| get     | Show your time recordings for a specific day.                                       |\n| reset   | Reset your time recordings for a specific date.                                     |\n| check   | Show your monthly time balance.                                                     |\n| mapping | Customize the task to projectId mapping for your needs!                             |\n| quit    | Quit the cli.                                                                       |\n\n## Additional Notes\n\n📢 You may want to use the `mapping` command to customize the task to projectId mapping for your needs\nand let the cli do the magic for you.\n\nHints:\n\n- use `tab` to keep and edit initial values\n- use `ctrl+c` to escape from the current prompt and return to beginning\n\n# Miscellaneous\n\n## 🤝 Contributing\n\nContributions, [issues](https://github.com/pgebert/bcs-cli/issues) and feature requests are welcome!\n\n## Installation from source\n\nClone this repository and execute the following steps:\n\n```shell\ncd bcs-cli\nnpm run build\nnpm install --location=global .\n```\n\n## 💻 Development\n\nYou may want to create a `.env` file in the project ,directory with the evironment variables `BCS_URL`, `BCS_USERNAME`\nand `BCS_PASSWORD`.\n\nTo run the application without installing it globally:\n\n```shell\ncd bcs-cli\nnpm install\n\n# hot reloading\nnpm run start:dev\n\n# build and run\nnpm run build\nnpm run start\n\n# test\n npm run test\n \n # install global\n npm run build\n npm install -g projektron-bcs-cli .\n```\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2023 [pgebert](https://github.com/pgebert).  \nThis project is licensed under [Apache 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgebert%2Fprojektron-bcs-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpgebert%2Fprojektron-bcs-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgebert%2Fprojektron-bcs-cli/lists"}