{"id":13530683,"url":"https://github.com/mk-5/fjira","last_synced_at":"2025-04-04T20:05:13.111Z","repository":{"id":42647093,"uuid":"474399706","full_name":"mk-5/fjira","owner":"mk-5","description":"The golang fuzzy-find cli jira interface 🚀","archived":false,"fork":false,"pushed_at":"2024-11-13T06:57:20.000Z","size":5265,"stargazers_count":172,"open_issues_count":18,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-28T19:05:34.749Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mk-5.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"buy_me_a_coffee":"mateuszkulawik"}},"created_at":"2022-03-26T16:13:52.000Z","updated_at":"2025-03-23T07:00:08.000Z","dependencies_parsed_at":"2023-10-25T22:45:25.589Z","dependency_job_id":"d0356e76-80e0-47d4-af93-a6f1ffc64cd1","html_url":"https://github.com/mk-5/fjira","commit_stats":null,"previous_names":[],"tags_count":73,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mk-5%2Ffjira","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mk-5%2Ffjira/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mk-5%2Ffjira/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mk-5%2Ffjira/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mk-5","download_url":"https://codeload.github.com/mk-5/fjira/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242669,"owners_count":20907133,"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-08-01T07:00:53.490Z","updated_at":"2025-04-04T20:05:13.053Z","avatar_url":"https://github.com/mk-5.png","language":"Go","funding_links":["https://buymeacoffee.com/mateuszkulawik"],"categories":["Productivity","Software Packages","Go Tools","软件包","others","\u003ca name=\"online\"\u003e\u003c/a\u003eOnline search and resources","Table of Contents"],"sub_categories":["Testing","Other Software","其他软件"],"readme":"# Fjira - Fuzzy finder and TUI application for Jira.\n\n\u003cimg src=\"fjira.png\" alt=\"drawing\" width=\"256\"/\u003e\n\n[![Mentioned in Awesome Go](https://awesome.re/badge-flat.svg)](https://github.com/avelino/awesome-go)\n![Test](https://github.com/mk-5/fjira/actions/workflows/tests.yml/badge.svg)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://github.com/mk-5/fjira/blob/master/LICENSE)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/mk-5/fjira)\n[![Go Report Card](https://goreportcard.com/badge/github.com/mk-5/fjira)](https://goreportcard.com/report/github.com/mk-5/fjira)\n[![Go Reference](https://pkg.go.dev/badge/github.com/mk-5/fjira.svg)](https://pkg.go.dev/github.com/mk-5/fjira)\n[![codecov](https://codecov.io/gh/mk-5/fjira/branch/master/graph/badge.svg?token=MJBTMYGQQW)](https://codecov.io/gh/mk-5/fjira)\n\n## Introduction\n\nFjira is a powerful command-line tool designed to simplify your interactions with Jira. Whether you're a developer,\nproject manager, or just a Jira enthusiast, Fjira streamlines your workflow, making Jira tasks more efficient than ever\nbefore.\n\n![Fjira Demo](demo.gif)\n\n## Key Features\n\n- **Fuzzy-find like interface:** Search for Jira projects and issues with ease.\n- **Assignee Control:** Quickly change issue assignees without navigating the Jira interface.\n- **Status Updates:** Update Jira issue statuses directly from your terminal.\n- **Efficient Comments:** Easily append comments to Jira issues.\n- **Multi-Workspace Support:** Manage multiple Jira workspaces effortlessly.\n- **Custom Searches:** Use Jira Query Language (JQL) for tailored searches.\n- **Direct CLI Access:** Access Jira issues directly from the command line.\n- **Cross-Platform Compatibility:** Works seamlessly on macOS, Linux, and Windows.\n\n## Installation\n\n### macOS\n\n```shell\nbrew tap mk-5/mk-5\nbrew install fjira\n```\n\n### Linux\n\n#### Ubuntu/Snap\n\n```shell\nsnap install fjira\n```\n\n#### Deb\n\nVisit [https://github.com/mk-5/fjira/releases/latest](https://github.com/mk-5/fjira/releases/latest), and grab the\nlatest release version.\n\n```shell\nsudo dpkg -i fjira_0.4.0_linux_amd64.deb\n```\n\n#### AUR\n\n```sh\nyay -S fjira\n```\n\n#### Binary\n\n```shell\ntar -xvzf fjira_0.4.0_Linux_x86_64.tar.gz\ncp fjira /usr/local/bin/fjira\n```\n\n### Windows\n\n```shell\nchoco install fjira\n```\n\n### Build from sources\n\n```shell\nmake\n./out/bin/fjira\n```\n\n## Usage\n\n```text\nUsage:\n  fjira [flags]\n  fjira [command]\n\nAvailable Commands:\n  [issueKey]  Open a Jira issue directly from the CLI\n  completion  Generate the autocompletion script for the specified shell\n  filters     Search using Jira filters\n  help        Help about any command\n  jql         Search using custom JQL queries\n  version     Print the version number of fjira\n  workspace   Switch to a different workspace\n\nFlags:\n  -h, --help             help for fjira\n  -p, --project string   Open a project directly from CLI\n\nAdditional help topics:\n  fjira            Open a fuzzy finder for projects as a default action\n\nUse \"fjira [command] --help\" for more information about a command.\n```\n\n## Getting Started\n\nUsing the Fjira CLI is straightforward. Simply run fjira in your terminal.\n\n```shell\nfjira\n```\n\n## Workspaces\n\nThe first time you run Fjira, it will prompt you for your Jira API URL and token.\n\n![Fjira First Run](demo_first_run.gif)\n\nFjira workspaces store Jira configuration data in a simple YAML file located at `~/.fjira`. You can switch between\nmultiple workspaces using the `fjira workspace` command.\n\n```shell\nfjira workspace\n```\n\nTo create a new workspace, use the following command:\n\n```shell\nfjira workspace --new abc\n```\n\nYou can edit an existing workspace using the `--edit` flag:\n\n```shell\nfjira workspace --edit abc\n```\n\n### Jira Token Type\n\nFjira supports both Jira Server and Jira Cloud, which use different token types for authorization. The tool will prompt\nyou to select the appropriate token type during workspace configuration.\n\n```shell\n? Jira Token Type:\n\n1. api token\n2. personal token\n\nEnter a number (Default is 1):\n```\n\n### YAML configuration\n\nIf you prefer a manual approach, you have the option to add workspace configurations by creating a `fjira.yaml` file in the `~/.fjira/` directory. \nFor your convenience, an example configuration file is here: [fjira.yml](assets/fjira.yaml)\n\n## Projects search\n\nThe default view when you run `fjira` is the project search screen.\n\n```shell\nfjira\n```\n\n## Opening a Specific Project\n\nYou can open a project directly from the CLI:\n\n```shell\nfjira --project=PROJ\n```\n\nThis will skip the project search screen and take you directly to the issues search screen.\n\n## Opening an Issue Directly\n\nTo open an issue directly from the CLI:\n\n```shell\nfjira PROJ-123\n```\n\nFjira will skip all intermediate screens and take you directly to the issue view.\n\n![Fjira Issue View](demo_issue.png)\n\n## Boards View\n\nFjira also offers a board-like view. After opening a project, press F4 to access this view.\n\n![Fjira Board View](demo_board_view.png)\n\n## Custom JQL Queries\n\nYou can create and execute custom JQL queries with Fjira:\n\n```shell\nfjira jql\n```\n\n![Fjira Custom JQL](demo_custom_jql.png)\n\n## My Jira Filters\n\nYou can search using your stored (favourites) Jira Filters:\n\n```shell\nfjira filters\n```\n\n![Fjira Filters](demo_filters.png)\n\n## Custom Color Scheme\n\nTailor the fjira color scheme to match your preferences by creating a custom `~/.fjira/colors.yml` file. This file\nallows you to personalize the colors according to your unique style.\nRefer to the example file, located here: [colors.yml](assets/colors.yml)\n\n## Roadmap (TODO)\n\n- Expand Documentation\n- Create\u0026Delete Jira Filters\n- Support Additional Linux Package Managers (Apt, AUR, YUM)\n- Introduce More Jira Features\n\n## Motivation\n\nFjira was designed for personal convenience, born out of a desire for efficiency and a love for terminal tools.\nOften, we find ourselves in \"I just need to transition issue 123 to the next status.\" While opening Jira, locating the\nticket on the board, and navigating the Jira issue modal are all perfectly fine, they do consume a fair amount of time.\n\nFjira empowers you to execute such tasks directly from the terminal, where you're likely already working! 😄\n\nIf Fjira enhances your Jira experience as it did mine, please consider giving it a star on GitHub. 🌟 It will power-up me\nfor a future work.\n\nFeel free to contribute to this project and help shape its future! Your feedback and contributions are highly\nappreciated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmk-5%2Ffjira","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmk-5%2Ffjira","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmk-5%2Ffjira/lists"}