Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atlassianps/jiraps

PowerShell module to interact with Atlassian JIRA
https://github.com/atlassianps/jiraps

api atlassian atlassianps jira powershell powershell-gallery rest windows-powershell

Last synced: about 1 month ago
JSON representation

PowerShell module to interact with Atlassian JIRA

Host: GitHub
URL: https://github.com/atlassianps/jiraps
Owner: AtlassianPS
License: mit
Created: 2015-07-08T19:47:00.000Z (over 9 years ago)
Default Branch: develop
Last Pushed: 2024-04-05T14:55:09.000Z (7 months ago)
Last Synced: 2024-04-14T00:25:42.019Z (7 months ago)
Topics: api, atlassian, atlassianps, jira, powershell, powershell-gallery, rest, windows-powershell
Language: PowerShell
Homepage: https://AtlassianPS.org/module/JiraPS
Size: 2.53 MB
Stars: 318
Watchers: 41
Forks: 128
Open Issues: 136
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        ---

layout: module

permalink: /module/JiraPS/

---

# [JiraPS](https://atlassianps.org/module/JiraPS)

[![GitHub release](https://img.shields.io/github/release/AtlassianPS/JiraPS.svg?style=for-the-badge)](https://github.com/AtlassianPS/JiraPS/releases/latest)

[![Build Status](https://img.shields.io/github/actions/workflow/status/AtlassianPS/JiraPS/build_and_test.yml?style=for-the-badge)](https://github.com/AtlassianPS/JiraPS/actions/workflows/build_and_test.yml)

[![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/JiraPS.svg?style=for-the-badge)](https://www.powershellgallery.com/packages/JiraPS)

![License](https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge)

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](https://atlassianps.org/slack)

[SlackLogo]: https://atlassianps.org/assets/img/Slack_Mark_Web_28x28.png

---

## 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)

```powershell

# One time only install:

Install-Module JiraPS -Scope CurrentUser

# Check for updates occasionally:

Update-Module JiraPS

```

### Usage

```powershell

# 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](https://atlassianps.org/docs/JiraPS) and in the console.

```powershell

# 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](https://atlassianps.org/docs/JiraPS/).

### Contribute

Want to contribute to AtlassianPS? Great!

We appreciate [everyone](https://atlassianps.org/#people) 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"](https://containers.dev/) 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](https://code.visualstudio.com/),

its extension `ms-vscode-remote.remote-containers`,

and [docker](https://docs.docker.com/engine/install/).  

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](https://atlassianps.org/#people)) that helped with this module

## Useful links

* [Source Code]

* [Latest Release]

* [Submit an Issue]

* [Contributing]

* How you can help us: [List of Issues](https://github.com/AtlassianPS/JiraPS/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs)

## 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.

  [JIRA]: https://www.atlassian.com/software/jira

  [PowerShell Gallery]: https://www.powershellgallery.com/

  [Source Code]: https://github.com/AtlassianPS/JiraPS

  [Latest Release]: https://github.com/AtlassianPS/JiraPS/releases/latest

  [Submit an Issue]: https://github.com/AtlassianPS/JiraPS/issues/new

  [replicaJunction]: https://github.com/replicaJunction

  [MIT license]: https://github.com/AtlassianPS/JiraPS/blob/master/LICENSE

  [Contributing]: http://atlassianps.org/docs/Contributing