Skip to content

Commit da294c6

Browse files
committed
[docu] update CLI app documentation
1 parent 920ccb3 commit da294c6

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

Documentation/Development/CLI-application.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The output of the script is language aware. Just add a `--lang` argument:
2525
Copy `/etc/config.dist.json` to `/etc/config.json` and fill in your database details. To interface with GitHub, fill in your GitHub credentials.
2626

2727
Then run:
28-
`jtracker install`
28+
`jtracker install`
2929

3030
### Import a project from GitHub
3131

@@ -74,6 +74,16 @@ To turn the feature(s) off permanently edit `etc/config.json` and set the values
7474

7575
### Auto Complete
7676

77+
Auto complete files are provided for some environments.
78+
79+
Optionally you can generate the files four your language using
80+
81+
`jtracker make autocomplete --lang=xx-XX`
82+
83+
using one of the supported languages.
84+
85+
#### PHPStorm
86+
7787
If you use PHPStorm, you may use the [Command Line Tools Console](http://www.jetbrains.com/phpstorm/webhelp/command-line-tools-console-tool-window.html) to execute the jtracker script.
7888

7989
To get auto complete for the `jtracker` commands, copy the file `Custom_jtracker.xml` to the folder `.idea/commandlinetools` inside your JTracker project (create the folder if it does not exist). This will set up an alias `jt` that points to the `/bin/jtracker` script.
@@ -83,3 +93,27 @@ To get auto complete for the `jtracker` commands, copy the file `Custom_jtracker
8393
Don't miss the documentation - Press <kbd>Ctrl</kbd> + <kbd>Q</kbd>
8494

8595
![cli-auto-complete1](https://f.cloud.github.com/assets/2059654/739003/d0295894-e351-11e2-8ee6-973d8741a3cd.png)
96+
97+
#### The `fish` shell
98+
99+
Provides auto complete for users of the [fish shell](https://fishshell.com).
100+
101+
To use it, copy (or better symlink) the file
102+
`{repo}/cli/completions/jtracker.fish`
103+
to
104+
`~/.config/fish/completions/`
105+
and restart your shell.
106+
107+
Works in PHPStorms "Terminal".
108+
109+
![2016-07-15-125504_1366x768_scrot](https://cloud.githubusercontent.com/assets/33978/16890651/1dc653da-4ab6-11e6-91d8-ba62b1d11603.png)
110+
111+
![2016-07-15-125543_1366x768_scrot](https://cloud.githubusercontent.com/assets/33978/16890652/1dce0ada-4ab6-11e6-963c-01a0e5c2240a.png)
112+
113+
![2016-07-15-125430_1366x768_scrot](https://cloud.githubusercontent.com/assets/33978/16890650/1dc25906-4ab6-11e6-88d0-aeb7d1386e4a.png)
114+
115+
And of course in your favourite terminal too.
116+
117+
![tty](https://cloud.githubusercontent.com/assets/33978/16890656/2373b23c-4ab6-11e6-875b-d90f7d1de8a2.gif)
118+
119+
Happy auto completing `=;)`

0 commit comments

Comments
 (0)