/JiraPS

PowerShell module to interact with Atlassian JIRA

Primary LanguagePowerShellMIT LicenseMIT

layout permalink
module
/module/JiraPS/

GitHub release Build Status PowerShell Gallery License

JiraPS is a Windows PowerShell module to interact with Atlassian JIRA via a REST API, while maintaining a consistent PowerShell look and feel.

Join the conversation on SlackLogo AtlassianPS.Slack.com


Instructions

Installation

Install JiraPS from the PowerShell Gallery! Install-Module requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link)

# One time only install:
Install-Module JiraPS -Scope CurrentUser

# Check for updates occasionally:
Update-Module JiraPS

Usage

# To use each session:
Import-Module JiraPS
Set-JiraConfigServer 'https://YourCloud.atlassian.net'
New-JiraSession -Credential $cred

You can find the full documentation on our homepage and in the console.

# Review the help at any time!
Get-Help about_JiraPS
Get-Command -Module JiraPS
Get-Help Get-JiraIssue -Full # or any other command

For more information on how to use JiraPS, check out the Documentation.

Contribute

Want to contribute to AtlassianPS? Great! We appreciate everyone who invests their time to make our modules the best they can be.

Check out our guidelines on Contributing to our modules and documentation.

Tested on

Configuration Status
Windows Powershell v3
Windows Powershell v4
Windows Powershell v5.1 Build Status
Powershell Core (latest) on Windows Build Status
Powershell Core (latest) on Ubuntu Build Status
Powershell Core (latest) on MacOS Build Status

Acknowledgements

Useful links

Disclaimer

Hopefully this is obvious, but:

This is an open source project (under the MIT license), and all contributors are volunteers. All commands are executed at your own risk. Please have good backups before you start, because you can delete a lot of stuff if you're not careful.