{"id":13464770,"url":"https://github.com/abskmj/hukum","last_synced_at":"2025-10-19T03:33:04.877Z","repository":{"id":42011906,"uuid":"276085528","full_name":"abskmj/hukum","owner":"abskmj","description":"An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime.","archived":false,"fork":false,"pushed_at":"2023-02-03T11:13:01.000Z","size":705,"stargazers_count":403,"open_issues_count":5,"forks_count":24,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-30T08:18:41.868Z","etag":null,"topics":["developer-experience","developer-productivity","developer-tools","github-actions","github-api","javascript","npm","npm-module"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/hukum","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/abskmj.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}},"created_at":"2020-06-30T11:56:56.000Z","updated_at":"2024-10-15T04:28:51.000Z","dependencies_parsed_at":"2023-02-18T06:16:06.470Z","dependency_job_id":null,"html_url":"https://github.com/abskmj/hukum","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abskmj%2Fhukum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abskmj%2Fhukum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abskmj%2Fhukum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/abskmj%2Fhukum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/abskmj","download_url":"https://codeload.github.com/abskmj/hukum/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271517,"owners_count":20911587,"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":["developer-experience","developer-productivity","developer-tools","github-actions","github-api","javascript","npm","npm-module"],"created_at":"2024-07-31T14:00:50.049Z","updated_at":"2025-10-19T03:33:04.817Z","avatar_url":"https://github.com/abskmj.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"![npm (scoped)](https://img.shields.io/npm/v/hukum?label=NPM) ![NPM](https://img.shields.io/npm/l/hukum?label=License) ![npm](https://img.shields.io/npm/dt/hukum?label=Downloads) [![Sponsor](https://img.shields.io/static/v1?label=Sponsor\u0026message=%E2%9D%A4\u0026color=red\u0026logo=GitHub)](https://github.com/abskmj/hukum)\n\n# Hukum - Displays Github Action progress in terminal\nHukum is an NPM module that displays Github Action (GA) progress in the terminal. It works for workflows that run when a commit is pushed to Github repo. Once a commit is pushed, Hukum will print status updates in realtime.\n\nHukum aims to improve your development experience with immediate feedback of the GA Workflow in your terminal.\n\n![](.images/terminal.gif)\n\n# Installation\n```bash\nnpm install --global hukum\n\nhukum\n```\n\n# How it works?\nHukum uses [Github Actions API](https://docs.github.com/en/rest/reference/actions) to get the related workflow to the recent git push and its status. It keeps on calling the APIs every 1 second to update the status on the terminal.\n\nBelow is a sample output for one of the workflows.\n\n```\n   Add post - Setup Snapcraft in a Github Action Workflow\n     ✔ deploy 16s\n       ✔ Set up job 2s\n       ✔ Run actions/checkout@v2 0s\n       ✔ Install hugo 8s\n       ✔ Install hugo theme 1s\n       ✔ Build 0s\n       ✔ Deploy 5s\n       ✔ Post Run actions/checkout@v2 0s\n       ✔ Complete job 0s\n```\n\n# Configuration\nHukum can work out of the box without any configuration. However, it provides a few configuration options. Include a `.hukumrc` file in your home directory or the root of the project with the following contents or set the below environment variables.\n\n```json\n{\n    \"github\": {\n        \"token\": \"\u003ctoken\u003e\"\n    }\n}\n```\n\n## Github Personal token\n```js\n// .hukumrc\n{ \"github\": { \"token\": \"\u003ctoken\u003e\" } }\n```\n```bash\n# environment variable\nHUKUM_GITHUB_TOKEN=\u003ctoken\u003e\n```\n\nHukum uses [Github Actions API](https://docs.github.com/en/rest/reference/actions). It is possible to use these APIs without any authentication for public repositories. However, for unauthenticated requests, the rate limit allows for up to 60 requests per hour (Details at [docs.github.com](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)) which can exhaust quickly. Authenticated requests have higher limits, up to 5000 requests per hour.\n\n\nYou can follow these steps at [docs.github.com](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to create a personal token. The token does not need to have any specific scope for public repositories. However, the token  needs to have `repo - Full control of private repositories` scope for private repositories.\n\n# Fixes \u0026 Improvements\nHead over to the issues tab at [github.com](https://github.com/abskmj/hukum/issues) to report a bug or suggest an improvement. Feel free to contribute to the code or documentation by raising a pull request.\n\n# Sponsor / Support\nIf you find the project interesting or helpful, please consider sponsoring or supporting it at [github.com](https://github.com/abskmj/hukum).\n\n# Links\n- [NPM Repository](https://www.npmjs.com/package/hukum)\n- [Changelog](https://github.com/abskmj/hukum/releases)\n- [Report an issue](https://github.com/abskmj/hukum/issues)\n- [Source Code](https://github.com/abskmj/hukum)\n- [License](https://github.com/abskmj/hukum/blob/master/LICENSE)\n- [Sponsor](https://github.com/abskmj/hukum)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabskmj%2Fhukum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fabskmj%2Fhukum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fabskmj%2Fhukum/lists"}