Skip to content

Latest commit

 

History

History
96 lines (78 loc) · 5.49 KB

README.md

File metadata and controls

96 lines (78 loc) · 5.49 KB
Raw

Issue

It can sometimes be frustrating as hell to switch to your browser from your IDE or terminal to view task requirements. It can be even more irritating when these websites don't have proper keyboard support.

To combat all this, Issue is a simple CLI utility for viewing and marking GitLab project issues (Support for Jira, Github and Clubhouse coming soon!).

Quickstart

  • Download the executable corresponding to your OS from the table below.

    OS & Architecture Link
    Darwin (Mac OS) AMD64 Download
    Darwin (Mac OS) ARM64 Download
    Linux 386 Download
    Linux AMD64 Download
    Linux ARM Download
    Linux ARM64 Download
    Windows 386 Download
    Windows AMD64 Download

  • Add the path of the directory, in which the executable is present, to your PATH environment variable.

  • Run issue version to verify the successful installation!

Initial Setup

  • Run issue init.
  • Open the generated issues.config.json file.
    • Generate a Gitlab API token. Only provide read_* permissions to the token. Paste your token as the value for the BearerToken attribute in the config file.
    • The value for the HostUrl attribute must be the full domain URL at which Gitlab is hosted for you (ex; https://mycompany.com/gitlab or https://gitlab.mycompany.com). If you are using the cloud (normal) version of Gitlab, use https://gitlab.com.
    • The value for the RepositoryNamespace attribute must be the repository name (ex; ArjArav98/Issue or stark-industries/ironmansuit).

Usage

Issue Listings Commands Description
issue list Lists all issues.
issue list --assignee_username darth.vader69 --labels "Doing,Backend" Lists all issues after applying search parameters. For full list of search parameters and examples, click here.
issue list --my-open-issues Shortcut which displays all issues assigned to you, which are open.
issue list --my-issues Shortcut which displays all issues assigned to you.
Detailed Issue View Commands Description
issue show <issue_id> Displays the selected issue in detail.
issue show --with-comments <issue_id> Displays the selected issue in detail, along with its comments.
issue show --no-comments <issue_id> Displays the selected issue's comments only.
Miscellaneous Commands Description
issue init Creates an empty config file in the current directory.
issue version Displays the current version of the tool.
issue help Displays a help menu with usage instructions for each command.

Listings Search Parameters

Search Parameter Possible Values
--assignee_id (integer/Any/None)
--assignee_username (comma-separated-strings)
--created_after (datetime)
--created_before (datetime)
--updated_after (datetime)
--updated_before (datetime)
--labels (comma-separated-strings)
--search (string)
--order_by (created_at/updated_at/)
--state (opened/closed)

Examples;

issue list --my-open-issues --labels backend,doing --created_before --created_before 2012-12-21
issue list --assignee_username sauron123 --assignee_username frodo99

Tip: You could also create aliases in your terminal for searches with multiple arguments.

Troubleshooting & Common Errors

  • If you encounter a 'permission denied' message on Mac OS, you might have to change the permissions of the executable file to 711. Once this is over, you will have to go to System Preferences -> Security & Privacy and allow Issue to be 'opened anyway'.
  • If you encounter a 'no config present' error, please make sure you are at the root of a directory which has been initialised with a git repository.

Potential Contributions

Feel free to submit a PR for a feature addition or bug. It would be great if you could submit an issue first so that we can discuss whether the potential PR fits within the general direction that the project is going in.

Tools Used

  • Gitlab APIs
  • Vim