layout: module

permalink: /module/JiraPS/

JiraPS

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.

DevContainer

This repository offers a “devcontainer” setup.

What are Development Containers?
A development container (or dev container for short) allows you to use
a container as a full-featured development environment.
It can be used to run an application, to separate tools, libraries,
or runtimes needed for working with a codebase,
and to aid in continuous integration and testing.

You can use the devcontainer to spin up a fine tuned development environment with
everything you need for working on this project.

The easiest way for using DevContainers is with VS Code,
its extension ms-vscode-remote.remote-containers,
and docker.
When opening the repository in VS Code, it will recommend the installation of the extension.
And once installed, you will be prompted to “Reopen in Container”.

Tested on

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

Acknowledgements

Thanks to replicaJunction for getting this module on its feet
Thanks to everyone (Our Contributors) that helped with this module

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.