README
atlassian
jira and confluence command line interface.
Table of Contents
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
List Tasks
Generally, jira list
command can help to list all tasks
jira.js 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:
get all mine tasks in development for open sprint:
jira ls -dm
where
ls
is alias forlist
command and-dm
means mine tasks in dev statussearch 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.js 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.js 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]
Confluence cli
Get list of pages
confluence.js 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.js 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.