Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changed all required parameters to not be positional anymore, adapted use case accordingly

...

Command line specified > custom config file with -c > user config file > global config file

Command

Positional(Required)

Parameters

Optional

Parameters

DescriptionRequirements
listissues 

--project: The project's identifier in Jira


Pretty prints, to stdout, all the issues for a given project name, in order of creation descending.

Could redirect output to save in file.

Browsing Permissions
createissue

--project: The identifier of the project to add the issue to.

--summary: Headline of the issue to be created. Put in quotation marks if it contains spaces.

--desc: Description of the issue to be created.

--issuetype: How the issue should be categorized. Examples are bug, task, feature, subtask,...

--priority: Number from 1-5 where 1 is a Blocker and 5 is Trivial.

 --assignee: The username of the requested assignee, if one should be immediately assigned.

--parent: The identifier of the parent issue. Only required if you create a subtask.

Creates an issue for the given project name.

Browsing and Issue Creation Permissions

initconfigNone

--conffile: Absolute path to the file where the config values should be saved/overwritten. If it doesn't exist, attempt to create it there.

Any of username, password, oAuthToken, consumerKey, consumerSecret, oAuthSecretToken, authMethod, privateKeyLocation, baseurl that should be saved in the config file

Initialize or change a config fileNone
createoauthNone

--consumerkey: The name of the OAuth public key as configured on the Jira Server. Specify to use a different one than the config file has.

--consumersecret: The OAuth secret as configured on the Jira Server. Specify to use a different one than the config file has.

--pkeyloc: Path to the private to be used for the creation of this token.

Create an OAuth token.

Important:

OAuth Consumer must have been configured server-side by an Administrator. 
A Tutorial on how to configure that can be found on the official Atlassian Jira Documentation:
https://developer.atlassian.com/server/jira/platform/oauth/
(Only Step 1 is relevant, Step 2 and 3 are handled by JiraClient)

Consumer secret and key already configured on Jira.

Private Key used must correspond to configured public key.

...

Code Block
collapsetrue
jira-client listissues --project EXAMPLEPROJECTNAME

Example Output:

...

Code Block
jira-client createissue --project EXAMPLEPROJECTNAME --summary "This is the headline" --desc "This is a multi-lined\ndescription" --issuetype Bug --priority 4

No output when successful.

...