atlassian

jira and confluence command line interface.

🇺🇦 Help Ukraine

I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone.

We fight for democratic values, freedom, for our future! Once again Ukrainians have to stand against evil, terror, against genocide. The outcome of this war will determine what path human history is taking from now on.

💛💙 Help Ukraine! We need your support! There are dozen ways to help us, just do it!

Table of Contents

• Requirements
• Installation
• Usage
• Contribute

Requirements

To use library you need to have node and npm installed in your machine:

• node >=10
• npm >=6

Note: if you received yargs error "yargs parser supports a minimum Node.js version of x", try to set evironment variable YARGS_MIN_NODE_VERSION=10.

Package is continuously tested on darwin, linux and win32 platforms. All active and maintenance LTS node releases are supported.

Installation

To install the library run the following command

  npm i -g atlassian

Usage

Jira cli

Init

jira init

Add attlasian profile

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

List Tasks

Generally, jira list command can help to list all tasks

jira list [--dev] [--mine] [--search=<search>] [--sprint=<sprint>] [--verbose]
[--profile=<profile>]

List Tasks

Options:
  -h, --help                Show help                                                 [boolean]
      --version             Show version number                                       [boolean]
  -v, --verbose             verbose logs                                              [boolean]
  -p, --profile             specify profile name                                       [string]
  -d, --dev, --development  filter only tasks in development                          [boolean]
  -m, --mine, --my          filter only mine issues                                   [boolean]
  -s, --search, --grep      search issues by summary                                   [string]
      --sprint              specify sprints for filter
                                           [array] [choices: "all", "open"] [default: ["open"]]

Some common examples:

1. get all mine tasks in development for open sprint:

      jira ls -dm

   where ls is alias for list command and -dm means mine tasks in dev status

2. search issues that contains memory leak words:

      jira ls -s 'memory leak'

   where -s is a shortcut for --search or --grep

Send issue(s) to testing

jira test [--verbose] [--profile=<profile>] <issueId...>

Send task to testing

Options:
  -h, --help     Show help                                                            [boolean]
      --version  Show version number                                                  [boolean]
  -v, --verbose  verbose logs                                                         [boolean]
  -p, --profile  specify profile name                                                  [string]
      --issueId  id(s) of task                                                          [array]

Clear worklog

jira worklog clear <issueId> [--verbose] [--profile=<profile>]

Clear worklog

Positionals:
  <issueId>  Id of the issue                                                           [string]

Options:
  -h, --help     Show help                                                            [boolean]
      --version  Show version number                                                  [boolean]
  -v, --verbose  verbose logs                                                         [boolean]
  -p, --profile  specify profile name                                                  [string]

Print jira statuses

jira statuses [--verbose] [--profile=<profile>]

List jira configuration statuses

Options:
  -h, --help     Show help                                                            [boolean]
      --version  Show version number                                                  [boolean]

Confluence cli

Init

confluence init

Add attlasian profile

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Get list of pages

confluence pages <space> [--profile=<profile>] [--verbose]

List Pages

Options:
      --version  Show version number                                                  [boolean]
  -h, --help     Show help                                                            [boolean]
  -v, --verbose  verbose logs                                                         [boolean]
      --debug    debug logs                                                           [boolean]
      --space    Id of confluence space                                                [string]

Export page of pdf

To export specific page as pdf firstly obtain pageId. Then use pageId as argument for next command:

confluence export <page> [--path=<path>] [--verbose] [--debug] [--profile=<profile>]

Export Page as pdf

Options:
      --version  Show version number                                                  [boolean]
  -h, --help     Show help                                                            [boolean]
  -v, --verbose  verbose logs                                                         [boolean]
      --debug    debug logs                                                           [boolean]
      --page     Id of space page                                                      [string]

Path to generated .pdf will be written to stdout.

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.