{"id":13452087,"url":"https://github.com/ZeroX-DG/CommitTasks","last_synced_at":"2025-03-23T19:33:33.899Z","repository":{"id":57204271,"uuid":"145294490","full_name":"ZeroX-DG/CommitTasks","owner":"ZeroX-DG","description":"A combination between git commit \u0026 todo list :tada:","archived":false,"fork":false,"pushed_at":"2019-02-09T00:55:26.000Z","size":2048,"stargazers_count":296,"open_issues_count":0,"forks_count":7,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-17T23:19:49.607Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/ZeroX-DG.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-19T10:47:34.000Z","updated_at":"2024-10-31T16:36:38.000Z","dependencies_parsed_at":"2022-09-18T00:51:06.832Z","dependency_job_id":null,"html_url":"https://github.com/ZeroX-DG/CommitTasks","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FCommitTasks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FCommitTasks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FCommitTasks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZeroX-DG%2FCommitTasks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZeroX-DG","download_url":"https://codeload.github.com/ZeroX-DG/CommitTasks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245158975,"owners_count":20570294,"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":[],"created_at":"2024-07-31T07:01:12.378Z","updated_at":"2025-03-23T19:33:33.380Z","avatar_url":"https://github.com/ZeroX-DG.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/hQteV8A"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eCommitTasks\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e\n  Plan \u0026 commit your changes with ease :tada:\n\u003c/h4\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"assets/demo-ct.gif\" width=\"80%\" /\u003e\n\u003c/div\u003e\n\n## About this project\n\nCommitTasks is a small, robust cli for developers to plan and manage their git commits in multiple projects. In other words, CommitTasks is a combination of `git commit` \u0026 todo list.\nWith just a few examples, the users can learn to plan, prepare and commit their changes with confident.\n\n## Features\n\n- Manage commit tasks in separate projects\n- Search for tasks\n- Simple \u0026 easy to use\n- Commit and receive commit details\n- Highlight tasks\n\n## Install\n\n```\nnpm install -g committasks\n```\n\n## Usage\n\n```\n$ ct --help\n\n  Usage:\n    $ ct [\u003coptions\u003e ...]\n\n    Options:\n        none            Display all tasks\n      --task, -t        Create task\n      --remove, -rm     Remove a task or a project\n      --commit, -c      Commit a task\n      --list, -l        Display all tasks in a project\n      --find, -f        Search for a task\n      --edit, -e        Edit a task commit's message\n      --create, -cp     Create a project for a task (requires --task)\n\n    Examples:\n      $ ct\n      $ ct --task MyProject Fix issue #45\n      $ ct --remove MyProject 1\n      $ ct --remove . 1\n      $ ct --commit MyProject 2\n      $ ct --commit . 2\n      $ ct --list MyProject\n      $ ct --list .\n      $ ct --find My task\n      $ ct --edit MyProject 2 New message\n      $ ct --edit . 2 New message\n      $ ct --task NotExistProject Fix issue #45 --create\n      $ ct --create --task NewProject Fix issue #45\n```\n\n## How to use\n\nIn all the examples bellow, if your current working directory has the same name as your project name in CommitTasks list then you can replace your project name with a `.` character.\n\n### Create task\n\nYou can use `--task`/`-t` flag to create a new task.\n\n```\n$ ct --task MyProject Updated README with the new details\n```\n\nIf the project that you are about to create does not exist then you must specify the flag `--create`/`--cp` for CommitTasks to understand that you want to create a new project.\n\n```\n$ ct --task ProjectToBeCreated Improve documentation --create\n```\n\n### Commit a task\n\nAfter you apply all your changes, you can use the flag `--commit`/`--c` followed by your project name and task id to commit your changes. Your task content will be used as the commit message.\n\n```\n$ ct --commit MyProject 1\n```\n\nIf no files are specified, `git add .` will be assumed. However, if you want to specify a set files to be commited, you can combine the `--commit`/`--c` flag with `--files`/`--cf` flag to specify the files that you want to commit.\n\n```\n$ ct --commit MyProject 1 --files index.js css/index.css index.html\n```\n\n### List all task in a project\n\nIf you're working on a specific project and only wish to see tasks in that project, then you can use the `--list`/`--l` flag with a project name to show only tasks in your desired project.\n\n```\n$ ct --list MyProject\n```\n\n### Edit a task commit message\n\nAs mentioned earlier, the task content will be used as the commit message by default. If you wish to change it, use the `--edit`/`--e` flag followed by the project name, task id and the new message.\n\n```\n$ ct --edit MyProject 1 Updated commit message\n```\n\n### Highlight a task\n\nTo highlight a task, you can use the flag `--highlight`/`--hl` followed by the project name, task id and the status of the highlight that you want.\nSupported status:\n\n- `urgent`\n- `important`\n- `none`\n\n```\n$ ct --highlight MyProject 1 urgent\n```\n\n### Remove a task or project\n\nTo remove a task, you can simply use the flag `--remove`/`--rm` followed by the project name and the task id.\n\n```\n$ ct --remove MyProject 1\n```\n\nYou can do the same thing to delete the whole project, but this time, only project name is required.\n\n```\n$ ct --remove MyProject\n```\n\n## Author\n\n- Hung Nguyen \u003cviethungax@gmail.com\u003e ([twitter](https://twitter.com/ZeroX_Hung))\n\n## Donations\n\n\u003ca href=\"https://www.buymeacoffee.com/hQteV8A\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\n## License\n\n[MIT](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZeroX-DG%2FCommitTasks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FZeroX-DG%2FCommitTasks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZeroX-DG%2FCommitTasks/lists"}