tebriel / jira-cli Goto Github PK

Simple Command Line Jira Client in Node.js

License: MIT License

CoffeeScript 72.76% JavaScript 27.24%

jira-cli's Introduction

This project is abandoned. The NPM module is likely to be changed. The maintainer of https://github.com/danshumaker/jira-cmd approached me asking for the name within npm, and I've granted access. So there will be a whole new package in npm unrelated to this project.

jira-cli

This is a command line client for jira, because no one likes their terrible interface.

Getting Started

Install the module with: npm install -g jira-cli
Run it with jira

What does it do?

Lists all a user's issues
List all a user's projects
Finds an issue by Key (AB-123) or Id (123456)
Opens an issue
Allows user to add a new ticket to different projects
Transitions an issue (shows all available transition states)
Adds a worklog to an issue
Allow searching to be limited by project id

TODO

PROFIT?
MOAR testing

Documentation

GitHub Documentation

Examples

jira -l

jira -f AB-123

Notes

If you use https: for jira, add "protocol": "https:" to your .jiraclirc.json If your ssl certs are also self-signed add: "strictSSL": false to your .jiraclirc.json

Testing

Using jasmine-node with grunt currently. Tests are a bit silly, but they helped me learn jasmine spies. So that's good.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

0.5.0 Changing list (-l) to to use the query resolution = unresolved (Thanks to zowens)
0.4.1 Accidentally quitting before callback was finished
0.4.0 Now able to ignore self-signed SSL Certs and specify protocol
0.3.1 Fixed some bugs
0.3.0 Updated version of jira
0.2.9 Fixed an issue where special characters were in the username
0.2.8 Fixed issue with create that would prevent you from creating
0.2.7 Fixed typo that prevented -w from working
0.2.6 Now takes -o to limit to specific project(s)
0.2.5 Now normalizing event types and item types
0.2.4 I did something here, don't remember
0.2.3 Fixed an issue where invalid input caused an exception
0.2.2 Added wordrap to -d so that the text is easier to grok
0.2.1 Added -d flag to show details for list/find
0.2.0 Refactored organization. Creates config file if not present
0.1.9 Defaults for project in config, lists others if desired
0.1.8 Now allows entry of worklog when transitioning items, or by itself
0.1.7 Now requiring my custom npm module for node-jira-devel
0.1.6 Transitioning now shows all available options
0.1.5 Listing Id for project
0.1.4 Listing Types in Create
0.1.3 Listing Projects
0.1.2 Moar Minor Doc Changes
0.1.1 Minor Doc Changes
0.1.0 Initial Release

License

jira-cli's People

Contributors

Stargazers

Watchers

jira-cli's Issues

Issue when using transition

When I try to transition a issue

jira -t PROJ-123

I get the following error:

TypeError: Object #<Object> has no method 'sort'
    at /usr/local/lib/node_modules/jira-cli/lib/jira.js:55:19
    at /usr/local/lib/node_modules/jira-cli/lib/jira-cli.js:154:18
    at Request._callback (/usr/local/lib/node_modules/jira-cli/node_modules/jira/lib/jira.js:1255:17)
    at Request.self.callback (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:127:22)
    at Request.emit (events.js:98:17)
    at Request.<anonymous> (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:767:16)
    at Request.emit (events.js:117:20)
    at IncomingMessage.<anonymous> (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:729:14)
    at IncomingMessage.emit (events.js:1

Using the latest version in npm

Adding issue to non default project doesn't work

Tried to add an issue with a different project ID and it created it on my default project.

Error in the JQL Query: The character '.' is a reserved JQL character. You must enclose it in a string or use the escape '\u002e' instead. (line 1, character 17)

$ jira ls
Error in the JQL Query: The character '.' is a reserved JQL character. You must enclose it in a string or use the escape '\u002e' instead. (line 1, character 17)
$

What can it be?

jira show work perfectly

Remap Status Codes

When transitioning an issue, if non-standard transitions are available, remap the codes to easier to type number (1, 2, 3, 4, 711 -> 1, 2, 3, 4, 5) and send 711

password is stored in plaintext

Allow 204 requests to be valid on issue update

weird ssl error while connecting...

when i try any command I get

Error listing projects: Error: write EPROTO 140735168680704:error:140770FC:SSL routines:SSL23_GET_SERVER_HELLO:unknown protocol:../deps/openssl/openssl/ssl/s23_clnt.c:782:

here is my config

{
  "user":"USER",
  "password":"PASS",
  "host":"acompany.atlassian.net",
  "protocol":"https:",
  "strictSSL": false,
  "port":"80",
  "project":10003
}

ive tried all kinds of variations of protocol and strictSSL... no luck...

Unable to actually get this working?

JSON file as import for worklog

It would be great if one could use a JSON file to save its work, and then at the end of day with a single jira run do the logging (mostly worklog).

Such as:

/file
[
{ issue: "CORE-154",
start: "2014-01-20 09:55:29",
end: "2014-01-20 09:55:34",
comment: "Done this and that"
},
{
issue: "MORE-123",
sart: "2014-01-20 09:59:40"
end "2014-01-20 09:59:41",
comment: "Save it to the space"
}
]
/end of file

Commands never end, have to CTRL+C to exit

I'm not sure if it is hanging on purpose or what... but it could be useful for piping to properly exit the command.

Error connecting to HTTPS server

Hey, this project is very interesting. I was trying it but i can't connect to the server.

I tried with many combinations of hosts and ports, but i'll paste here the one i think it's correct and should be working:

Config

{"user":"user","password":"password","host":"jira.domain.com","port":"443","project":"project"}

Output:

❯ jira -l --debug
Error retreiving issues list: Error: socket hang up

(Yeah, i figured out that --debug.)

Can you point me how to connect to a HTTPS server?
Thanks.

App is failing silently

Not really sure how to debug this, but I try to create an issue and nothing seems to happen. There is no error, and no ticket is actually created. I am using JIRA-OnDemand if that matter. Any suggestions on how I might debug this thing ?

`--details` flag doesn't actually do anything

Executing jira --list --details gives me exactly the same output as jira --list.

Correction: jira -f PROJECT-1234 --details does return the long description of the issue.

Implement -v (--version) option

to see which version you have installed.

Allow viewing of description

It would be great if this would allow for the viewing of the description with or without comments of each individual issue. This is available through the rest api at rest/api/2/issue/EX-0000 via the description key

https://docs.atlassian.com/jira/REST/latest/#d2e1223

Allow searching to be limited by project id

When listing out issues, allow a tag to limit the list to a specific project (or projectS)

Explain config creation

Hey, it would be really helpful if you could provide examples of what to provide the configuration creating script when one first runs jira. i.e I have no idea what's the port of my JIRA installation. Could also be helpful to provide sane defaults.

Have a Current Working Issue in Jira-cli

It would be nice to be able to automatically pull up and work on an issue without having to list and then modify it that way.

Fuzzy issue search/matching

When working with multiple jira issues, it's hard to remember the exact issue number. Mostly you remember only the project and some keywords from its title. It's troublesome to start the jira web interface just to find this out.

It would be great if the cli would first do an exact check and then fallback to search list, from which to user can choose.

Such as:
CORE-12 (Found, used)
CORE-Integration progress (Issue code not found, done search for issues in project core, with the title containing the words progress and issue, found 12 matches, a simple number selection menu appears [1-12], with an additional zero being none of them).

This would be not that hard, and from my experience teribly useful :)

lclotman@dev01 /var/ci/stuport_app [master *]
± % jira -a                                                                                                                                                                 !4784
Project (Enter for Default/? for list) [STUPORT] :
Summary: test
Description: foo
Error listing issueTypes: Error: Parse Error

lclotman@dev01 /var/ci/stuport_app [master *]
± % jira -l                                                                                                                                                                 !4785
Error retreiving issues list: Error: Parse Error

I can't figure out why that is happening. My credentials appear to be correct.

± % cat ~/.jiraclirc.json                                                                                                                                                   !4786
{
    "user":     "USER",
    "password": "PW",
    "host":     "jira.example.com",
    "port":     "443",
    "project":  "STUPORT"
}

I've altered username, password and host for privacy reasons.

TypeError: Object #<Object> has no method 'sort'

jira -t XXXX-9999

TypeError: Object #<Object> has no method 'sort'
    at /usr/local/lib/node_modules/jira-cli/lib/jira.js:55:19
    at /usr/local/lib/node_modules/jira-cli/lib/jira-cli.js:154:18
    at Request._callback (/usr/local/lib/node_modules/jira-cli/node_modules/jira/lib/jira.js:1255:17)
    at Request.self.callback (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:127:22)
    at Request.EventEmitter.emit (events.js:98:17)
    at Request.<anonymous> (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:767:16)
    at Request.EventEmitter.emit (events.js:117:20)
    at IncomingMessage.<anonymous> (/usr/local/lib/node_modules/jira-cli/node_modules/jira/node_modules/request/main.js:729:14)
    at IncomingMessage.EventEmitter.emit (events.js:117:20)
    at _stream_readable.js:920:16

probably related to #20 ?

Add Oauth Option

Definitely needs to be added to node-jira too.

Invalid input in transition causes Error

Due to bad spacing on + sign in data-utils.coffee.

[cmoultrie@Sauron Dropbox]$ jira -t EG-131
2 - Close Issue
4 - Start Progress
5 - Resolve Issue
Transtion Type :

/usr/local/lib/node_modules/jira-cli/lib/data-utils.js:15
        stdout.write("It should match: " + format(+"\n"));
                                           ^
TypeError: object is not a function
    at ReadStream.ask (/usr/local/lib/node_modules/jira-cli/lib/data-utils.js:15:44)
    at ReadStream.g (events.js:193:14)
    at ReadStream.EventEmitter.emit (events.js:93:17)
    at TTY.onread (net.js:396:14)