mirror of
https://github.com/Threnklyn/jira.git
synced 2026-06-06 21:20:48 +02:00
clean up README (mostly spelling fixes)
This commit is contained in:
@@ -28,13 +28,13 @@ go get -v
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
**go-jira** uses a configuration heirarchy. When loading the configuration from disk it will recursively look through
|
**go-jira** uses a configuration hierarchy. When loading the configuration from disk it will recursively look through
|
||||||
all parent directories in your current path looking for a **.jira.d** directory anywhere in your. (If your current directory is not
|
all parent directories in your current path looking for a **.jira.d** directory. If your current directory is not
|
||||||
a child directory of your homedir, then your homedir will also be inspected for a **.jira.d** directory. From all of **.jira.d** directories
|
a child directory of your homedir, then your homedir will also be inspected for a **.jira.d** directory. From all of **.jira.d** directories
|
||||||
discovered **go-jira** will load a **config.yml** found. The configuration properties found in a file closests to your current working directory
|
discovered **go-jira** will load a **config.yml** if found. The configuration properties found in a file closests to your current working directory
|
||||||
will have precedence. Properties overriden with command line options will have final precedence.
|
will have precedence. Properties overriden with command line options will have final precedence.
|
||||||
|
|
||||||
The complicated configuration heirarchy is used because **go-jira** attempts to be context aware. For example if you are working on a "foo" project and
|
The complicated configuration heirarchy is used because **go-jira** attempts to be context aware. For example, if you are working on a "foo" project and
|
||||||
you `cd` into your project workspace, wouldn't it be nice if `jira ls` automatically knew to list only issues related to the "foo" project? Likewise when you
|
you `cd` into your project workspace, wouldn't it be nice if `jira ls` automatically knew to list only issues related to the "foo" project? Likewise when you
|
||||||
`cd` to the "bar" project then `jira ls` should only list issues related to "bar" project. You can do this with by creating a configuration under your project
|
`cd` to the "bar" project then `jira ls` should only list issues related to "bar" project. You can do this with by creating a configuration under your project
|
||||||
workspace at **./.jira.d/config.yml** that looks like:
|
workspace at **./.jira.d/config.yml** that looks like:
|
||||||
@@ -55,30 +55,29 @@ EOM
|
|||||||
|
|
||||||
### Editing
|
### Editing
|
||||||
|
|
||||||
when you run command like `jira edit` it will open up your favorite editor with the templatized output, so you can quickly edit. When then editor
|
When you run command like `jira edit` it will open up your favorite editor with the templatized output so you can quickly edit. When the editor
|
||||||
closes then **go-jira** will submit the complted form. To specify your editor, and this is the order which **go-jira** attempts to determine your p
|
closes **go-jira** will submit the completed form. The order which **go-jira** attempts to determine your prefered editor is:
|
||||||
prefered editor:
|
|
||||||
|
|
||||||
* **editor** property in any config.yml file
|
* **editor** property in any config.yml file
|
||||||
* **JIRA_EDITOR** envionment variable
|
* **JIRA_EDITOR** environment variable
|
||||||
* **EDITOR** environment variable
|
* **EDITOR** environment variable
|
||||||
* vim
|
* vim
|
||||||
|
|
||||||
### Templates
|
### Templates
|
||||||
|
|
||||||
**go-jira** has the ability to customize most output (and editor input) via templates There are default templates available for all operations,
|
**go-jira** has the ability to customize most output (and editor input) via templates. There are default templates available for all operations,
|
||||||
which may or may not work for your actual jira implementation. Jira is endlessly customizable, so it is hard to provide default templates
|
which may or may not work for your actual jira implementation. Jira is endlessly customizable, so it is hard to provide default templates
|
||||||
that will work for all issue types.
|
that will work for all issue types.
|
||||||
|
|
||||||
When running a command like `jira edit` it will look through the current directory hierachy trying to find a file that matches **.jira.d/templates/edit**,
|
When running a command like `jira edit` it will look through the current directory hierarchy trying to find a file that matches **.jira.d/templates/edit**,
|
||||||
if found it will use that file as the template, otherwise it will use the default **edit** template hard-coded into **go-jira**. You can export the default
|
if found it will use that file as the template, otherwise it will use the default **edit** template hard-coded into **go-jira**. You can export the default
|
||||||
hard-coded templates with `jira export-templates` which will write then to **~/.jira.d/templtes/.**.
|
hard-coded templates with `jira export-templates` which will write them to **~/.jira.d/templates/**.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage:
|
Usage:
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] (ls|list) ( [-q JQL] | [-p PROJECT] [-c COMPONENT] [-a ASSIGNEE] [-i ISSUETYPE])
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] (ls|list) ( [-q JQL] | [-p PROJECT] [-c COMPONENT] [-a ASSIGNEE] [-i ISSUETYPE])
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] view ISSUE
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] view ISSUE
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] edit ISSUE [-m COMMENT] [-o KEY=VAL]...
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] edit ISSUE [-m COMMENT] [-o KEY=VAL]...
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] create [-p PROJECT] [-i ISSUETYPE] [-o KEY=VAL]...
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] create [-p PROJECT] [-i ISSUETYPE] [-o KEY=VAL]...
|
||||||
@@ -99,29 +98,29 @@ Usage:
|
|||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] issuelinktypes
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] issuelinktypes
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] transmeta ISSUE
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] transmeta ISSUE
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] editmeta ISSUE
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] editmeta ISSUE
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] issuetypes [-p PROJECT]
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] issuetypes [-p PROJECT]
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] createmeta [-p PROJECT] [-i ISSUETYPE]
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] createmeta [-p PROJECT] [-i ISSUETYPE]
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] transitions ISSUE
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] transitions ISSUE
|
||||||
jira [-v ...] export-templates [-d DIR]
|
jira [-v ...] export-templates [-d DIR]
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] login
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] login
|
||||||
jira [-v ...] [-u USER] [-e URI] [-t FILE] ISSUE
|
jira [-v ...] [-u USER] [-e URI] [-t FILE] ISSUE
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
-e --endpoint=URI URI to use for jira
|
-e --endpoint=URI URI to use for jira
|
||||||
-h --help Show this usage
|
-h --help Show this usage
|
||||||
-t --template=FILE Template file to use for output/editing
|
-t --template=FILE Template file to use for output/editing
|
||||||
-u --user=USER Username to use for authenticaion (default: cbennett)
|
-u --user=USER Username to use for authenticaion (default: $USER)
|
||||||
-v --verbose Increase output logging
|
-v --verbose Increase output logging
|
||||||
--version Show this version
|
--version Show this version
|
||||||
|
|
||||||
Command Options:
|
Command Options:
|
||||||
-a --assignee=USER Username assigned the issue
|
-a --assignee=USER Username assigned the issue
|
||||||
-c --component=COMPONENT Component to Search for
|
-c --component=COMPONENT Component to Search for
|
||||||
-d --directory=DIR Directory to export templates to (default: /Users/cbennett/.jira.d/templates)
|
-d --directory=DIR Directory to export templates to (default: $HOME/.jira.d/templates)
|
||||||
-i --issuetype=ISSUETYPE Jira Issue Type (default: Bug)
|
-i --issuetype=ISSUETYPE Jira Issue Type (default: Bug)
|
||||||
-m --comment=COMMENT Comment message for transition
|
-m --comment=COMMENT Comment message for transition
|
||||||
-o --override=KEY:VAL Set custom key/value pairs
|
-o --override=KEY:VAL Set custom key/value pairs
|
||||||
-p --project=PROJECT Project to Search for
|
-p --project=PROJECT Project to Search for
|
||||||
-q --query=JQL Jira Query Language expression for the search
|
-q --query=JQL Jira Query Language expression for the search
|
||||||
-w --watcher=USER Watcher to add to issue (default: cbennett)
|
-w --watcher=USER Watcher to add to issue (default: $USER)
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user