https://github.com/atlassianps/jiraagileps
PowerShell module to interact with Jira's Agile plugin
https://github.com/atlassianps/jiraagileps
Last synced: over 1 year ago
JSON representation
PowerShell module to interact with Jira's Agile plugin
- Host: GitHub
- URL: https://github.com/atlassianps/jiraagileps
- Owner: AtlassianPS
- License: mit
- Created: 2018-05-27T18:59:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T20:03:01.000Z (over 2 years ago)
- Last Synced: 2024-04-14T00:25:41.822Z (over 2 years ago)
- Language: PowerShell
- Homepage:
- Size: 45.9 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
---
layout: module
permalink: /module/JiraAgilePS/
---
# [JiraAgilePS](https://atlassianps.org/module/JiraAgilePS)
JiraAgilePS is a PowerShell module to interact with _Agile_, Atlassian [JIRA]'s plugin,
via a REST API, while maintaining a consistent PowerShell look and feel.
> JiraAgilePS is a module that extends [JiraPS](https://atlassianps.org/module/JiraPS).
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 JiraAgilePS 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 JiraAgilePS -Scope CurrentUser
# Check for updates occasionally:
Update-Module JiraAgilePS
```
### Usage
```powershell
# To use each session:
Import-Module JiraAgilePS
Set-JiraConfigServer 'https://YourCloud.atlassian.net'
New-JiraSession -Credential $cred
```
You can find the full documentation on our [homepage](https://atlassianps.org/docs/JiraAgilePS)
and in the console.
```powershell
# Review the help at any time!
Get-Help about_JiraAgilePS
Get-Command -Module JiraAgilePS
Get-Help Get-JiraAgileBoard -Full # or any other command
```
For more information on how to use JiraAgilePS, check out the [Documentation](https://atlassianps.org/docs/JiraAgilePS/).
### 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".
## Acknowledgments
* 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/JiraAgilePS/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/JiraAgilePS
[Latest Release]: https://github.com/AtlassianPS/JiraAgilePS/releases/latest
[Submit an Issue]: https://github.com/AtlassianPS/JiraAgilePS/issues/new
[replicaJunction]: https://github.com/replicaJunction
[MIT license]: https://github.com/AtlassianPS/JiraAgilePS/blob/master/LICENSE
[Contributing]: http://atlassianps.org/docs/Contributing