{"id":13471859,"url":"https://github.com/go-jira/jira","last_synced_at":"2026-01-12T00:33:08.849Z","repository":{"id":27152037,"uuid":"30621185","full_name":"go-jira/jira","owner":"go-jira","description":"simple jira command line client in Go","archived":false,"fork":false,"pushed_at":"2025-11-11T19:18:28.000Z","size":4371,"stargazers_count":2718,"open_issues_count":177,"forks_count":341,"subscribers_count":91,"default_branch":"master","last_synced_at":"2025-12-10T03:15:47.581Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/go-jira.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-02-10T23:57:33.000Z","updated_at":"2025-11-30T23:45:25.000Z","dependencies_parsed_at":"2024-04-10T01:49:55.938Z","dependency_job_id":"4fa95f0a-305c-4b62-8dcf-0bad7ddd5113","html_url":"https://github.com/go-jira/jira","commit_stats":{"total_commits":668,"total_committers":67,"mean_commits":9.970149253731343,"dds":"0.43113772455089816","last_synced_commit":"4263bd24f9e9c702a92358c5cd7ce0ddd711df4c"},"previous_names":["go-jira/go-jira","netflix-skunkworks/go-jira"],"tags_count":65,"template":false,"template_full_name":null,"purl":"pkg:github/go-jira/jira","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-jira%2Fjira","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-jira%2Fjira/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-jira%2Fjira/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-jira%2Fjira/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/go-jira","download_url":"https://codeload.github.com/go-jira/jira/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/go-jira%2Fjira/sbom","scorecard":{"id":432016,"data":{"date":"2025-08-11","repo":{"name":"github.com/go-jira/jira","commit":"f50f3d2b164f3815894a91f93c9bdcbdf4aaf5b4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Code-Review","score":8,"reason":"Found 13/15 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/prepare-release.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/main.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prepare-release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/prepare-release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/prepare-release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/prepare-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:94: update your workflow using https://app.stepsecurity.io/secureworkflow/go-jira/jira/release.yml/master?enable=pin","Warn: containerImage not pinned by hash: _t/Dockerfile:1: pin your Docker image by updating alpine:latest to alpine:latest@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Warn: goCommand not pinned by hash: .github/workflows/main.yml:19","Warn: goCommand not pinned by hash: .github/workflows/release.yml:30","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   2 goCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.0.27 not signed: https://api.github.com/repos/go-jira/jira/releases/32289532","Warn: release artifact v1.0.26 not signed: https://api.github.com/repos/go-jira/jira/releases/31144486","Warn: release artifact v1.0.25 not signed: https://api.github.com/repos/go-jira/jira/releases/31128448","Warn: release artifact v1.0.24 not signed: https://api.github.com/repos/go-jira/jira/releases/30750089","Warn: release artifact v1.0.23 not signed: https://api.github.com/repos/go-jira/jira/releases/24014125","Warn: release artifact v1.0.27 does not have provenance: https://api.github.com/repos/go-jira/jira/releases/32289532","Warn: release artifact v1.0.26 does not have provenance: https://api.github.com/repos/go-jira/jira/releases/31144486","Warn: release artifact v1.0.25 does not have provenance: https://api.github.com/repos/go-jira/jira/releases/31128448","Warn: release artifact v1.0.24 does not have provenance: https://api.github.com/repos/go-jira/jira/releases/30750089","Warn: release artifact v1.0.23 does not have provenance: https://api.github.com/repos/go-jira/jira/releases/24014125"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"39 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0411 / GHSA-3839-6r69-m497 / GHSA-xg2h-wx96-xgxr","Warn: Project is vulnerable to: GO-2021-0059 / GHSA-w942-gw6m-p62c","Warn: Project is vulnerable to: GO-2022-0957 / GHSA-wjm3-fq3r-5x46","Warn: Project is vulnerable to: GO-2021-0054 / GHSA-p64j-r5f4-pwwx","Warn: Project is vulnerable to: GO-2021-0265 / GHSA-ppj4-34rq-v8j9","Warn: Project is vulnerable to: GO-2022-0209 / GHSA-r5c5-pr8j-pfp7","Warn: Project is vulnerable to: GO-2023-1992 / GHSA-x3jr-pf6g-c48f","Warn: Project is vulnerable to: GO-2022-0229 / GHSA-cjjc-xp8v-855w","Warn: Project is vulnerable to: GO-2020-0012 / GHSA-ffhg-7mh4-33c4","Warn: Project is vulnerable to: GO-2021-0227 / GHSA-3vm4-22fp-5rfm","Warn: Project is vulnerable to: GO-2022-0968 / GHSA-gwc9-m7rh-j2ww","Warn: Project is vulnerable to: GO-2021-0356 / GHSA-8c26-wmh5-6g9v","Warn: Project is vulnerable to: GO-2024-2961","Warn: Project is vulnerable to: GO-2023-2402 / GHSA-45x7-px36-x8w8","Warn: Project is vulnerable to: GO-2024-3321 / GHSA-v778-237x-gjrc","Warn: Project is vulnerable to: GO-2025-3487 / GHSA-hcg3-q754-cr77","Warn: Project is vulnerable to: GO-2021-0078 / GHSA-5p4h-3377-7w67","Warn: Project is vulnerable to: GO-2022-0193 / GHSA-fcf9-6fv2-fc5v","Warn: Project is vulnerable to: GO-2022-0192 / GHSA-2wp2-chmh-r934","Warn: Project is vulnerable to: GO-2022-0197 / GHSA-4r78-hx75-jjj2 / GHSA-mv93-wvcp-7m7r","Warn: Project is vulnerable to: GO-2020-0014 / GHSA-vfw5-hrgq-h5wf","Warn: Project is vulnerable to: GO-2022-0536 / GHSA-39qc-96h7-956f / GHSA-hgr8-6h9x-f7q9","Warn: Project is vulnerable to: GO-2022-0236 / GHSA-h86h-8ppg-mxmh","Warn: Project is vulnerable to: GO-2021-0238 / GHSA-83g2-8m93-v3w7","Warn: Project is vulnerable to: GO-2022-0288","Warn: Project is vulnerable to: GO-2022-0969 / GHSA-69cg-p879-7622","Warn: Project is vulnerable to: GO-2022-1144 / GHSA-xrjj-mj9h-534m","Warn: Project is vulnerable to: GO-2023-1571 / GHSA-vvpx-j8f3-3w6h","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2022-0493 / GHSA-p782-xgp4-8hr8","Warn: Project is vulnerable to: GO-2021-0061 / GHSA-r88r-gmrh-7j83","Warn: Project is vulnerable to: GO-2022-0956 / GHSA-6q6q-88xp-6f2r","Warn: Project is vulnerable to: GO-2020-0036 / GHSA-wxc4-f4m6-wwqv"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T03:36:04.901Z","repository_id":27152037,"created_at":"2025-08-19T03:36:04.901Z","updated_at":"2025-08-19T03:36:04.901Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28329799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:13:06.322Z","status":"ssl_error","status_checked_at":"2026-01-12T00:04:50.725Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-31T16:00:49.846Z","updated_at":"2026-01-12T00:33:08.830Z","avatar_url":"https://github.com/go-jira.png","language":"Go","funding_links":[],"categories":["Go","others"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/go-jira/jira.svg?branch=master)](https://travis-ci.org/go-jira/jira)\n[![GoDoc](https://godoc.org/github.com/go-jira/jira?status.svg)](https://godoc.org/github.com/go-jira/jira)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n# go-jira\n\nSimple command line client for Atlassian's Jira service written in Go.\n\n## GDPR USERNAME DISCLAIMER\n\nWhen this tool was initial written the \"username\" parameter was widely used in the Atlassian API.\nDue to GDPR restrictions this parameter was been almost completely phased out other then V1 login.\nThe \"--user\" field is still provided as a default global, however moving forward any usage of this field should be phased out in favor of the \"--login\" option. \n\nCommands which previously took a username will now expect an email address such as watch, create, assign, etc...\n\n## Install\n\n### Download\n\nYou can download one of the pre-built binaries for **go-jira** [here](https://github.com/go-jira/jira/releases).\n\n### Build\n\nYou can build and install the official repository with [Go](https://golang.org/dl/) (before running the below command, ensure you have `GO111MODULE=on` set in your environment):\n\n\tgo get github.com/go-jira/jira/cmd/jira\n\nThis will checkout this repository into `$GOPATH/src/github.com/go-jira/jira/`, build, and install it.\n\nIt should then be available in $GOPATH/bin/jira.\n\n## Usage\n\n\n#### Setting up TAB completion\n\nSince go-jira is built with the \"kingpin\" golang command line library we support bash/zsh shell completion automatically:\n\n * \u003chttps://github.com/alecthomas/kingpin/tree/v2.2.5#bashzsh-shell-completion\u003e\n\nFor example, in bash, adding something along the lines of:\n\n  `eval \"$(jira --completion-script-bash)\"`\n\nto your bashrc, or .profile (assuming go-jira binary is already in your path) will cause jira to offer tab completion behavior.\n\n## Configuration\n\n**go-jira** uses a configuration hierarchy.  When loading the configuration from disk it will recursively look through all parent directories in your current path looking for a **.jira.d** directory.  If your current directory is not a child directory of your homedir, then your homedir will also be inspected for a **.jira.d** directory.  From all of **.jira.d** directories discovered **go-jira** will load a **\u0026lt;command\u0026gt;.yml** file (ie for `jira list` it will load `.jira.d/list.yml`) then it will merge in any properties from the **config.yml** if found.  The configuration properties found in a file closest to your current working directory will have precedence.  Properties overridden with command line options will have final precedence.\n\nThe complicated configuration hierarchy is used because **go-jira** attempts to be context aware.  For example, if you are working on a \"foo\" project and you `cd` into your project workspace, wouldn't it be nice if `jira ls` automatically knew to list only issues related to the \"foo\" project?  Likewise when you `cd` to the \"bar\" project then `jira ls` should only list issues related to \"bar\" project.  You can do this with by creating a configuration under your project workspace at **./.jira.d/config.yml** that looks like:\n\n```yaml\nproject: foo\n```\n\nYou will need to specify your local jira endpoint first, typically in your homedir like:\n\n```bash\nmkdir ~/.jira.d\n\ncat \u003c\u003cEOM \u003e~/.jira.d/config.yml\nendpoint: https://jira.mycompany.com\nEOM\n```\n\nThen use `jira login` to authenticate yourself as $USER. To change your username, use the `-u` CLI flag or set `user:` in your config.yml\n\n### Dynamic Configuration\n\nIf the **.jira.d/config.yml** file is executable, then **go-jira** will attempt to execute the file and use the stdout for configuration.  You can use this to customize templates or other overrides depending on what type of operation you are running.  For example if you would like to use the \"table\" template when ever you run `jira ls`, then you can create a template like this:\n\n```sh\n#!/bin/sh\n\necho \"endpoint: https://jira.mycompany.com\"\necho \"editor: emacs -nw\"\n\ncase $JIRA_OPERATION in\n    list)\n      echo \"template: table\";;\nesac\n```\n\nOr if you always set the same overrides when you create an issue for your project you can do something like this:\n\n```sh\n#!/bin/sh\necho \"project: GOJIRA\"\n\ncase $JIRA_OPERATION in\n    create)\n        echo \"assignee: $USER\"\n        echo \"watchers: mothra\"\n        ;;\nesac\n```\n\n### Custom Commands\nYou can now create custom commands for `jira` just by editing your `.jira.d/config.yml` config file.  These commands are effectively shell-scripts that can have documented options and arguments. The basic format is like:\n```yaml\ncustom-commands:\n  - command1\n  - command2\n```\n##### Commands\nWhere the individual commands are maps with these keys:\n* `name: string` [**required**] This is the command name, so for `jira foobar` you would have `name: foobar`\n* `help: string` This is help message displayed in the usage for the command\n* `hidden: bool` This command will be hidden from users, but still executable.  Sometimes useful for constructing complex commands where one custom command might call another.\n* `default: bool` Use this for compound command groups.  If you wanted to have `jira foo bar` and `jira foo baz` you would have two commands with `name: foo bar` and `name: foo baz`.  Then if you wanted `jira foo baz` to be called by default when you type `jira foo` you would set `default: true` for that custom command.\n* `options: list`  This is the list of possible option flags that the command will accept\n* `args: list` This is the list of command arguments (like the ISSUE) that the command will accept.\n* `aliases: string list`: This is a list of alternate names that the user can provide on the command line to run the same command.  Typically used to shorten the command name or provide alternatives that users might expect.\n* `script: string` [**required**] This is the script that will be executed as the action for this command. The value will be treated as a template and substitutions for options and arguments will be made before executing.\n\n##### Options\nThese are possible keys under the command `options` property:\n* `name: string` [**required**] Name of the option, so `name: foobar` will result in `--foobar` option.\n* `help: string` The help message displayed in usage for the option.\n* `type: string`:  The type of the option, can be one of these values: `BOOL`, `COUNTER`, `ENUM`, `FLOAT32`, `FLOAT64`, `INT8`, `INT16`, `INT32`, `INT64`, `INT`, `STRING`, `STRINGMAP`, `UINT8`, `UINT16`, `UINT32`,  `UINT64` and `UINT`.  Most of these are primitive data types an should be self-explanatory.  The default type is `STRING`. There are some special types:\n  * `COUNTER` will be an integer type that increments each time the option is used.  So something like `--count --count` will results in `{{options.count}}` of `2`.\n  * `ENUM` type is used with the `enum` property.  The raw type is a string and **must** be one of the values listed in the `enum` property.\n  * `STRINGMAP` is a `string =\u003e string` map with the format of `KEY=VALUE`.  So `--override foo=bar --override bin=baz` will allow for `{{options.override.foo}}` to be `bar` and `{{options.override.bin}}` to be `baz`.\n* `short: char` The single character option to be used so `short: c` will allow for `-c`.\n* `required: bool` Indicate that this option must be provided on the command line.  Conflicts with the `default` property.\n* `default: any` Specify the default value for the option.  Conflicts with the `required` property.\n* `hidden: bool` Hide the option from the usage help message, but otherwise works fine.  Sometimes useful for developer options that user should not play with.\n* `repeat: bool` Indicate that this option can be repeated.  Not applicable for `COUNTER` and `STRINGMAP` types.  This will turn the option value into an array that you can iterate over.  So `--day Monday --day Thursday` can be used like `{{range options.day}}Day: {{.}}{{end}}`\n* `enum: string list` Used with the `type: ENUM` property, it is a list of strings values that represent the set of possible values the option accepts.\n\n##### Arguments\nThese are possible keys under the command `args` property:\n* `name: string` [**required**] Name of the option, so `name: ISSUE` will show in the usage as `jira \u003ccommand\u003e ISSUE`.  This also represents the name of the argument to be used in the script template, so `{{args.ISSUE}}`.\n* `help: string` The help message displayed in usage for the argument.\n* `type: string`:  The type of the argument, can be one of these values: `BOOL`, `COUNTER`, `ENUM`, `FLOAT32`, `FLOAT64`, `INT8`, `INT16`, `INT32`, `INT64`, `INT`, `STRING`, `STRINGMAP`, `UINT8`, `UINT16`, `UINT32`,  `UINT64` and `UINT`.  Most of these are primitive data types an should be self-explanatory.  The default type is `STRING`.  There are some special types:\n  * `COUNTER` will be an integer type that increments each the argument is provided  So something like `jira \u003ccommand\u003e ISSUE-12 ISSUE-23` will results in `{{args.ISSUE}}` of `2`.\n  * `ENUM` type is used with the `enum` property.  The raw type is a string and **must** be one of the values listed in the `enum` property.\n  * `STRINGMAP` is a `string =\u003e string` map with the format of `KEY=VALUE`.  So `jira \u003ccommand\u003e foo=bar bin=baz` along with a `name: OVERRIDE` property will allow for `{{args.OVERRIDE.foo}}` to be `bar` and `{{args.OVERRIDE.bin}}` to be `baz`.\n* `required: bool` Indicate that this argument must be provided on the command line.  Conflicts with the `default` property.\n* `default: any` Specify the default value for the argument.  Conflicts with the `required` property.\n* `repeat: bool` Indicate that this argument can be repeated.  Not applicable for `COUNTER` and `STRINGMAP` types.  This will turn the template value into an array that you can iterate over.  So `jira \u003ccommand\u003e ISSUE-12 ISSUE-23` can be used like `{{range args.ISSUE}}Issue: {{.}}{{end}}`\n* `enum: string list` Used with the `type: ENUM` property, it is a list of strings values that represent the set of possible values for the argument.\n\n##### Script Template\nThe `script` property is a template that would produce `/bin/sh` compatible syntax after the template has been processed.  There are 2 key template functions `{{args}}` and `{{options}}` that return the parsed arguments and option flags as a map.\n\nTo demonstrate how you might use args and options here is a `custom-test` command:\n```yaml\ncustom-commands:\n  - name: custom-test\n    help: Testing the custom commands\n    options:\n      - name: abc\n        short: a\n        default: default\n      - name: day\n        type: ENUM\n        enum:\n          - Monday\n          - Tuesday\n          - Wednesday\n          - Thursday\n          - Friday\n        required: true\n    args:\n      - name: ARG\n        required: true\n      - name: MORE\n        repeat: true\n    script: |\n      echo COMMAND {{args.ARG}} --abc {{options.abc}} --day {{options.day}} {{range $more := args.MORE}}{{$more}} {{end}}\n```\n\nThen to run it:\n```\n$ jira custom-test\nERROR Invalid Usage: required flag --day not provided\n\n$ jira custom-test --day Sunday\nERROR Invalid Usage: enum value must be one of Monday,Tuesday,Wednesday,Thursday,Friday, got 'Sunday'\n\n$ jira custom-test --day Tuesday\nERROR Invalid Usage: required argument 'ARG' not provided\n\n$ jira custom-test --day Tuesday arg1\nCOMMAND arg1 --abc default --day Tuesday\n\n$ jira custom-test --day Tuesday arg1 more1 more2 more3\nCOMMAND arg1 --abc default --day Tuesday more1 more2 more3\n\n$ jira custom-test --day Tuesday arg1 more1 more2 more3 --abc non-default\nCOMMAND arg1 --abc non-default --day Tuesday more1 more2 more3\n\n$ jira custom-test --day Tuesday arg1 more1 more2 more3 -a short-non-default\nCOMMAND arg1 --abc short-non-default --day Tuesday more1 more2 more3\n```\n\nThe script has access to all the environment variables that are in your current environment plus those that `jira` will set.  `jira` sets environment variables for each config property it has parsed from `.jira.d/config.yml` or the command configs at `.jira.d/\u003ccommand\u003e.yml`.  It might be useful to see all environment variables that `jira` is producing, so here is a simple custom command to list them:\n```yaml\ncustom-commands:\n  - name: env\n    help: print the JIRA environment variables available to custom commands\n    script: |\n      env | grep JIRA\n ```\n\nYou could use the environment variables automatically, so if your `.jira.d/config.yml` looks something like this:\n```yaml\nproject: PROJECT\ncustom-commands:\n  - name: print-project\n    help: print the name of the configured project\n    script: \"echo $JIRA_PROJECT\"\n```\n\n##### Examples\n\n* `jira mine` for listing issues assigned to you\n```yaml\ncustom-commands:\n  - name: mine\n    help: display issues assigned to me\n    script: |-\n      if [ -n \"$JIRA_PROJECT\" ]; then\n          # if `project: ...` configured just list the issues for current project\n          {{jira}} list --template table --query \"resolution = unresolved and assignee=currentuser() and project = $JIRA_PROJECT ORDER BY priority asc, created\"\n      else\n          # otherwise list issues for all project\n          {{jira}} list --template table --query \"resolution = unresolved and assignee=currentuser() ORDER BY priority asc, created\"\n      fi\n```\n* `jira sprint` for listing issues in your current sprint\n```yaml\ncustom-commands:\n  - name: sprint\n    help: display issues for active sprint\n    script: |-\n      if [ -n \"$JIRA_PROJECT\" ]; then\n          # if `project: ...` configured just list the issues for current project\n          {{jira}} list --template table --query \"sprint in openSprints() and type != epic and resolution = unresolved and project=$JIRA_PROJECT ORDER BY rank asc, created\"\n      else\n          # otherwise list issues for all project\n          {{jira}} list --template table --query \"sprint in openSprints() and type != epic and resolution = unresolved ORDER BY rank asc, created\"\n      fi\n```\n\n### Editing\n\nWhen you run command like `jira edit` it will open up your favorite editor with the templatized output so you can quickly edit.  When the editor\ncloses **go-jira** will submit the completed form.  The order which **go-jira** attempts to determine your preferred editor is:\n\n* **editor** property in any config.yml file\n* **JIRA_EDITOR** environment variable\n* **EDITOR** environment variable\n* vim\n\n### Templates\n\n**go-jira** has the ability to customize most output (and editor input) via templates.  There are default templates available for all operations,\nwhich may or may not work for your actual jira implementation.  Jira is endlessly customizable, so it is hard to provide default templates\nthat will work for all issue types.\n\nWhen running a command like `jira edit` it will look through the current directory hierarchy trying to find a file that matches **.jira.d/templates/edit**,\nif found it will use that file as the template, otherwise it will use the default **edit** template hard-coded into **go-jira**.  You can export the default\nhard-coded templates with `jira export-templates` which will write them to **~/.jira.d/templates/**.\n\n#### Writing/Editing Templates\n\nFirst the basic templating functionality is defined by the Go language 'text/template' library.  The library reference documentation can be found [here](https://golang.org/pkg/text/template/), and there is a good primer document [here](https://gohugo.io/templates/go-templates/).  `go-jira` also provides a few extra helper functions to make it a bit easier to format the data, those functions are defined [here](https://github.com/go-jira/jira/blob/master/jiracli/templates.go#L64).\n\nKnowing what data and fields are available to any given template is not obvious. The easiest approach to determine what is available is to use the `debug` template on any given operation.  For example to find out what is available to the \"view\" templates, you can use:\n```\njira view GOJIRA-321 -t debug\n```\n\nThis will print out the data in JSON format that is available to the template.  You can do this for any other operation, like \"list\":\n```\njira list -t debug\n```\n\n### Authentication\n\n#### Atlassian Cloud\n\nFor Atlassian Cloud hosted Jira [API Tokens are now required](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-basic-auth-and-cookie-based-auth/).  You will automatically be prompted for an API Token if your jira endpoint ends in `.atlassian.net`.\n\n##### Quickstart API Token and Keychain\n\n1. Edit your config or execute the snippit (make sure to replace `\u003cSUBDOMAIN\u003e` and `\u003cEMAIL\u003e`)\n```\nexport SUBDOMAIN=\"https://\u003cSUBDOMAIN\u003e.atlassian.net\"\nexport EMAIL=\"\u003cEMAIL\u003e\"\nmkdir -p ~/.jira.d\nprintf \"endpoint: $SUBDOMAIN\\nuser: $EMAIL\\npassword-source: keyring\" \u003e ~/.jira.d/config.yml\n```\n2. Create a new API Token at [id.atlassian.com](https://id.atlassian.com/manage-profile/security)\n3. Execute `jira session` and enter your API Token. `jira` will add your session to the keyring.\n\n#### Private Jira Service\nIf you are using a private Jira service, you can force `jira` to use an api-token by setting the `authentication-method: api-token` property in your `$HOME/.jira.d/config.yml` file.  The API Token needs to be presented to the Jira service on every request, so it is recommended to store this API Token security within your OS's keyring, or using the `pass`/`gopass` service as documented below so that it can be programmatically accessed via `jira` and not prompt you every time.  For a less-secure option you can also provide the API token via a `JIRA_API_TOKEN` environment variable.  If you are unable to use an api-token for an Atlassian Cloud hosted Jira then you can still force `jira` to use the old session based authentication (until it the hosted system stops accepting it) by setting `authentication-method: session`.\n\nThe API Token authentication requires both the token and the email of the user. The email mut be set in the  `user:` in your config.yml. Failure to provide the `user` will result in a 401 error.\n\nIf your Jira service still allows you to use the Session based authentication method then `jira` will prompt for a password automatically when get a response header from the Jira service that indicates you do not have an active session (ie the `X-Ausername` header is set to `anonymous`).  Then after authentication we cache the `cloud.session.token` cookie returned by the service [session login api](https://docs.atlassian.com/jira/REST/cloud/#auth/1/session-login) and reuse that on subsequent requests.  Typically this cookie will be valid for several hours (depending on the service configuration).  To automatically securely store your password for easy reuse by jira You can enable a `password-source` via `.jira.d/config.yml` with possible values of `keyring`, `pass` or `gopass`.\n\nDepending on how your private Jira service is configured, API tokens may require the \"[Bearer][]\" authentication scheme instead of the traditional \"[Basic][]\" [authentication scheme][scheme]. In this case, set the `authentication-method: bearer-token` property in your `$HOME/.jira.d/config.yml` file.\n\n[scheme]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#authentication_schemes\n[Bearer]: https://datatracker.ietf.org/doc/html/rfc6750\n[Basic]: https://tools.ietf.org/html/rfc7617\n\n| **API token [scheme][]** | `authentication-method` | **Example HTTP request header**                 |\n|:------------------------:|-------------------------|-------------------------------------------------|\n|        [Basic][]         | `api-token`             | `Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQK` |\n|        [Bearer][]        | `bearer-token`          | `Authorization: Bearer MY_TOKEN`                |\n\n#### User vs Login\nThe Jira service has sometimes differing opinions about how a user is identified.  In other words the ID you login with might not be ID that the jira system recognized you as.  This matters when trying to identify a user via various Jira REST APIs (like issue assignment).  This is especially relevant when trying to authenticate with an API Token where the authentication user is usually an email address, but within the Jira system the user is identified by a user name.  To accommodate this `jira` now supports two different properties in the config file.  So when authentication using the API Tokens you will likely want something like this in your `$HOME/.jira.d/config.yml` file:\n```yaml\nuser: person\nlogin: person@example.com\n```\n\nYou can also override these values on the command line with `jira --user person --login person@example.com`.  The `login` value will be used only for authentication purposes, the `user` value will be used when a user name is required for any Jira service API calls.\n\n#### `keyring` password source\nOn OSX and Linux there are a few keyring providers that `go-jira` can use (via this [golang module](https://github.com/tmc/keyring)).  To integrate `go-jira` with a supported keyring just add this configuration to `$HOME/.jira.d/config.yml`:\n```yaml\npassword-source: keyring\n```\nAfter setting this and issuing a `jira login`, your credentials will be stored in your platform's backend (e.g. Keychain for Mac OS X) automatically. Subsequent operations, like a `jira ls`, should automatically login.\n\n#### `pass` password source\nAn alternative to the keyring password source is the `pass` tool (documentation [here](https://www.passwordstore.org/)).  This uses gpg to encrypt/decrypt passwords on demand and by using `gpg-agent` you can cache the gpg credentials for a period of time so you will not be prompted repeatedly for decrypting the passwords.  The advantage over the keyring integration is that `pass` can be used on more platforms than OSX and Linux, although it does require more setup.  To use `pass` for password storage and retrieval via `go-jira` just add this configuration to `$HOME/.jira.d/config.yml`:\n```yaml\npassword-source: pass\npassword-name: jira.example.com/myuser\n```\n\nThis assumes you have already setup `pass` correctly on your system.  Specifically you will need to have created a gpg key like this:\n\n```\n$ gpg --gen-key\n```\n\nThen you will need the GPG Key ID you want associated with `pass`.  First list the available keys:\n```\n$ gpg --list-keys\n/home/gojira/.gnupg/pubring.gpg\n-------------------------------------------------\npub   2048R/A307D709 2016-12-18\nuid                  Go Jira \u003cgojira@example.com\u003e\nsub   2048R/F9A047B8 2016-12-18\n```\n\nThen initialize the `pass` tool to use the correct key:\n```\n$ pass init \"Go Jira \u003cgojira@example.com\u003e\"\n```\n\nNow insert your password with the name you configured.\n\n```\n$ pass insert jira.example.com/myuser\n```\n\nYou probably want to setup gpg-agent so that you don't have to type in your gpg passphrase all the time.  You can get `gpg-agent` to automatically start by adding something like this to your `$HOME/.bashrc`\n```bash\nif [ -f $HOME/.gpg-agent-info ]; then\n    . $HOME/.gpg-agent-info\n    export GPG_AGENT_INFO\nfi\n\nif [ ! -f $HOME/.gpg-agent.conf ]; then\n  cat \u003c\u003cEOM \u003e$HOME/.gpg-agent.conf\ndefault-cache-ttl 604800\nmax-cache-ttl 604800\ndefault-cache-ttl-ssh 604800\nmax-cache-ttl-ssh 604800\nEOM\nfi\n\nif [ -n \"${GPG_AGENT_INFO}\" ]; then\n    nc  -U \"${GPG_AGENT_INFO%%:*}\" \u003e/dev/null \u003c/dev/null\n    if [ ! -S \"${GPG_AGENT_INFO%%:*}\" -o $? != 0 ]; then\n        # set passphrase cache so I only have to type my passphrase once a day\n        eval $(gpg-agent --options $HOME/.gpg-agent.conf --daemon --write-env-file $HOME/.gpg-agent-info --use-standard-socket --log-file $HOME/tmp/gpg-agent.log --verbose)\n    fi\nfi\nexport GPG_TTY=$(tty)\n```\n\n#### `gopass` password source\nThere is also the possibility to use [gopass](https://www.gopass.pw/) as a password source. `gopass` (like `pass`) uses gpg to encrypt/decrypt passwords. To use `gopass` for password storagte and retrieval via `go-jira` just add this configuration to `$HOME/.jira.d/config.yml`:\n```yaml\npassword-source: gopass\npassword-name: jira.example.com/myuser\n```\n\nFor this to work, you need a working `gopass` installation. \n\nTo configure your `gpg-agent` to cache your gpg passphrase take a look at the `pass` section of the readme. \n\n#### `stdin` password source\n\nWhen `password-source` is set to `stdin`, the `jira login` command will read from stdin until EOF, and the bytes read will be the used as the password. This is useful if you have some other programmatic method for fetching passwords. For example, if `password-generator` creates a one-time password and prints it to stdout, you could use it like this.\n\n```bash\n$ ./password-generator | jira login --endpoint=https://my.jira.endpoint.com --user=USERNAME\n```\n\n#### Switch path  used for password source\nFor `gopass` and `pass` it is possible to specify the full path for the `password-source` tool  used for retrieval of the password. This can be accomplised\nby setting the `password-source-path` option in the configuration file. \n\nE.g.\n```yaml\npassword-source: gopass\npassword-name: jira.example.com/myuser\npassword-source-path: /path/to/my-special-gopass\n```\n\nThis will cause go-jira to use the `gopass` style cli interaction with the `my-special-gopass` binary.\n\nIf you ommit the `password-source-path` option, either `gopass` (for `gopass`) or `pass` (for `pass`) \nwill be used.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgo-jira%2Fjira","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgo-jira%2Fjira","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgo-jira%2Fjira/lists"}