{"id":15294680,"url":"https://github.com/jaleelb/jira-flow","last_synced_at":"2026-01-04T12:39:16.459Z","repository":{"id":235619985,"uuid":"774906697","full_name":"JaleelB/jira-flow","owner":"JaleelB","description":"Jira-Flow is a CLI tool designed to link git commits with JIRA issues.","archived":false,"fork":false,"pushed_at":"2024-05-22T01:35:51.000Z","size":126,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-30T02:37:32.644Z","etag":null,"topics":["cli","commits","go","go-cli","golang","jira"],"latest_commit_sha":null,"homepage":"","language":"Go","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/JaleelB.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}},"created_at":"2024-03-20T12:16:54.000Z","updated_at":"2024-05-22T01:33:39.000Z","dependencies_parsed_at":"2024-04-24T01:55:57.950Z","dependency_job_id":"1c344de1-bedf-451d-9ede-2d0ec26ecf41","html_url":"https://github.com/JaleelB/jira-flow","commit_stats":null,"previous_names":["jaleelb/jira-flow"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JaleelB%2Fjira-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JaleelB%2Fjira-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JaleelB%2Fjira-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JaleelB%2Fjira-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JaleelB","download_url":"https://codeload.github.com/JaleelB/jira-flow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244739948,"owners_count":20501992,"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":["cli","commits","go","go-cli","golang","jira"],"created_at":"2024-09-30T17:05:57.566Z","updated_at":"2026-01-04T12:39:16.411Z","avatar_url":"https://github.com/JaleelB.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jira-Flow\n\nJira-Flow is a CLI tool designed to link git commits with JIRA issues.\n\n### Installation\n\n#### Using NPM (or any other package manager)\n\n```sh\nnpm install -g jira-flow\n```\n\n#### Quick Install Script (Linux/macOS)\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/JaleelB/jira-flow/main/installScripts/unix/install.sh | bash\n```\n\n#### Windows PowerShell\n\n```powershell\niwr -useb https://raw.githubusercontent.com/JaleelB/jira-flow/main/installScripts/windows/install.ps1 | iex\n```\n\n#### Homebrew (macOS)\n\n```bash\nbrew tap jaleelb/jira-flow\nbrew install jira-flow\n```\n\n#### Docker\n\n```bash\ndocker run --rm -it -v $(pwd):/git -w /git jaleelb/jira-flow init\n```\n\n#### From Source\n\nTo install Jira-Flow from source, including all associated binaries (`jiraflow`, `commitmsg`, `postco`), follow these steps:\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/JaleelB/jira-flow.git\n   cd jira-flow\n   ```\n\n2. Build the project (assuming Go is installed):\n\n   ```bash\n   go build -o jira-flow ./cmd/app/main.go\n   go build -o commitmsg ./hooks/commitmsg/main.go\n   go build -o postco ./hooks/post_checkout/main.go\n   ```\n\n3. Optionally, install the binary to a location in your PATH:\n\n   ```bash\n   sudo mv jira-flow /usr/local/bin\n   sudo mv commitmsg /usr/local/bin\n   sudo mv postco /usr/local/bin\n   ```\n\n   On Windows, move the `.exe` files to a directory that is included in your PATH.\n\n#### Manual Installation\n\nIf you prefer not to use npm, you can manually download the binaries from the [GitHub Releases page](https://github.com/JaleelB/jira-flow/releases).\n\n1. Navigate to the [Releases page](https://github.com/JaleelB/jira-flow/releases) of Jira-Flow.\n2. Download the appropriate binary for your operating system and architecture.\n3. Extract the downloaded archive and place the binary in a directory included in your system's PATH.\n\nFor example, on Unix-like systems:\n\n```bash\ntar -zxvf jiraflow_vX.X.X_os_arch.tar.gz\nsudo mv jiraflow /usr/local/bin\ntar -zxvf commitmsg_vX.X.X_os_arch.tar.gz\nsudo mv commitmsg /usr/local/bin\ntar -zxvf postco_vX.X.X_os_arch.tar.gz\nsudo mv postco /usr/local/bin\n```\n\nOn Windows, extract the files and add the folder to your PATH using the environment settings.\n\n### Usage\n\nOnce installed, you can use Jira-Flow with the following commands:\n\n```bash\n# Initialize JiraFlow\njira-flow init\n\n# Check JiraFlow status\njira-flow status\n\n# Toggle JiraFlow on/off\njira-flow status --toggle\n```\n\n### Commands\n\n- `init` - Initialize JiraFlow in your repository\n  ```bash\n  jira-flow init\n  ```\n  This opens an interactive menu where you can:\n  - Configure automatic/manual JIRA issue linking\n  - Check JiraFlow status\n  - Remove JiraFlow\n- `status` - Check JiraFlow configuration status\n\n  ```bash\n  jira-flow status\n  ```\n\n  Shows whether JiraFlow is active and which hooks are installed.\n\n  Use `--toggle` flag to enable/disable JiraFlow:\n\n  ```bash\n  jira-flow status --toggle\n  ```\n\n### Interactive Menu\n\nWhen running `jira-flow init`, you'll see an interactive menu with these options:\n\n1. **Configure** - Set up JiraFlow for your repository\n2. **Status** - Check current JiraFlow status\n3. **Remove** - Remove JiraFlow from repository\n4. **Exit** - Exit the CLI\n\n### A Quick Example\n\nHere's a quick example of initializing Jira-Flow and configuring it to automatically detect JIRA issue keys:\n\n```bash\n$ jira-flow init\n# Welcome message and logo displayed\n? How would you like to proceed:\n  ▸ Configure Jira-Flow for this repository\n    Check Jira-Flow status in this repository\n    Remove Jira-Flow from this repository\n    Exit Jira-Flow\n\n# User selects 'Configure Jira-Flow'\n? Choose configuration method:\n  ▸ Automatically link commits to Jira issues based on branch name\n    Manually link commits to Jira issues by entering the Jira issue key\n\n# User chooses 'Automatically'\n# Success message confirming automatic linking\n\"Success! The JIRA issue key will now be prepended to your commits.\"\n\n```\n\nOnce set up, Jira-Flow will prepend commit messages with the JIRA issue key, either detected from the branch name or entered manually, enhancing the integration between the developer's code repository and the JIRA tracking system.\n\n### Linking Commits to JIRA Issues\n\nFor more information on how JIRA issue keys can be used to reference issues in your development work, including commits, branches, and pull requests, see the official [Atlassian documentation](https://support.atlassian.com/jira-software-cloud/docs/reference-issues-in-your-development-work/).\n\n### Contributing\n\n- Fork the repository\n- Create a branch\n  ```bash\n  git checkout -b fix/amazingFix\n  ```\n- Commit your changes and push to your branch\n  ```bash\n  git commit -m \"made an amazingFix\"\n  git push origin fix/amazingFix\n  ```\n- Open a pull request\n\n### Checking JiraFlow Status\n\nYou can check if JiraFlow is active in your repository:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaleelb%2Fjira-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaleelb%2Fjira-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaleelb%2Fjira-flow/lists"}