https://github.com/colorfy-software/cfy
🎫 Jira integrated committing CLI.
https://github.com/colorfy-software/cfy
cli git jira
Last synced: about 1 month ago
JSON representation
🎫 Jira integrated committing CLI.
- Host: GitHub
- URL: https://github.com/colorfy-software/cfy
- Owner: colorfy-software
- License: mit
- Created: 2021-07-06T07:25:35.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-08-25T14:33:55.000Z (almost 4 years ago)
- Last Synced: 2025-09-07T07:20:19.243Z (10 months ago)
- Topics: cli, git, jira
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@colorfy-software/cfy
- Size: 162 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cfy
Jira integrated commiting CLI mainly to use at colorfy. After installing, just run `cfy` in any git project
# Usage
```sh-session
$ npm install -g @colorfy-software/cfy
$ cfy [In any git project]
$ cfy (-v | --version)
@colorfy-software/cfy/0.0.31 darwin-x64 node-v14.17.6
$ cfy --help [COMMAND]
$ cfy (-t | --ticket) [Take actions only on tickets without doing a commit]
```
# Template
To use a specific style of commits you can use the templating function in `./cfy-config.json`. For example add this to the config file after you have run `cfy` and done initial project setup within a git project:
```json
"wip_flag_template": " | WIP",
"commit_type_case": "uppercase",
"template": "[%JIRA_TICKET_KEY%%WIP_FLAG%] - %COMMIT_TYPE% - %COMMIT_MESSAGE%"
```
Output: "[JIRA-567 | WIP] - FEAT - Created a feature"