The script is located at /bin/jtracker and is meant to be executed on the computers command line interface.
This script will do:
- Setup the required database for the application.
- Initial import and further update of issues and issue comments from GitHub.
- Lots of other functionality for maintaining the application in sync and generate lots of useful stuff.
Usage:
jtracker <command> [action]
See: jtracker help for more information.
Or: jtracker help <command> for more information on a specific command.
Copy /etc/config.dist.json to /etc/config.json and fill in your database details. To interface with GitHub, fill in your GitHub credentials.
Then run:
jtracker install
The command jtracker get project will retrieve the information for a given project from GitHub.
This should be used during installation and periodical executions.
To bypass inputs and write the output to a log file during cron execution, a similar command could be used:
jtracker get:project -p 2 --all --status=all --quiet --noprogress --log cron.log
Note get:project will "batch run" the available get commands in the correct (..erm) order.
The Joomla! Framework's command line application class supports the display of colorful output on ANSI enabled terminals and the issue tracker makes use of this.
ANSI color codes are supported in most (if not all) *nix style terminals. Windows support was tested from a virtual machine running Windows XP with Git for Windows and GitHub for Windows (both include terminals) but neither those nor the standard Windows command prompt supported ANSI colors. Then Cygwin was installed and produced the following output:
Since there are some long running operations (over 10 minutes pulling the CMS' issues), we use the Joomla Console Package progress bar.
If your terminal does not support ANSI control codes you may see something like this:
To suppress color output for a single command use the --no-ansi switch.
To suppress the progress bar for a single command use the --noprogress switch.
Example:
jtracker get project --no-ansi --noprogress
To turn the feature(s) off permanently edit etc/config.json and set the values for the undesired features from 1 to 0.
Auto complete files are provided for some environments.
If you use PhpStorm, you may use the Command Line Tools Console to execute the jtracker script.
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.
Don't miss the documentation - Press Ctrl + Q
Provides auto complete for users of the fish shell.
To use it, copy (or better symlink) the file
{repo}/cli/completions/jtracker.fish
to
~/.config/fish/completions/
and restart your shell.
Works in PHPStorms "Terminal".
And of course in your favourite terminal too.
Happy auto completing =;)