The script is located at /bin/jtracker, which is a symlink to /cli/tracker.php created for convenience.
It 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.
The output of the script is language aware. Just add a --lang argument:
jtracker get project --lang=ru-RU
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.
Recently a new feature has been added to the framework that allows CLI applications to display colorful output on ANSI enabled terminals. So I thought we might see how it looks and feels ;)
ANSI color codes are supported in most (if not all) *nix style terminals. To test this feature I grabbed a VM with Windows XP, installed git for Windows and GitHub (both include terminals) but neither them nor the standard Windows thingy supported ANSI colors. Then I installed Cygwin (which is a good choice anyway), and got the following output:
Since we have some long running operations (currently ~10 min pulling the CMS issues on my slow i-net), I thought we might use some "high class" progress bar.
The progress bar is not part of the repo and has to be installed using composer from elkuku/console-progressbar (which is a fork of PEAR/Console_ProgressBar with a facelifting ;) I haven't tried that on Windows, but it might work on cygwin...
If your terminal does not support ANSI control codes you may see something like this:
To suppress color ouput for a single command use the --nocolors switch.
To suppress the progress bar for a single command use the --noprogress switch.
Example:
jtracker get project --nocolors --noprogress
To turn the feature(s) off permanently edit etc/config.json and set the values for the undesired features from 1 to 0.
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
