CLI

Configuration

In Uclusion go to the workspace and view which will be the sync target. Then from the workspace drop down choose CLI integration. In the CLI integration section of the resulting page you will see an example JSON file for this workspace and view.

Create a uclusion.json in the directory of the code you want synced with Uclusion. Change the sources and extensions list to be correct for this directory.

Now add a ~/.uclusion/credentials file with the contents shown in the CLI integration section.

Finally download the Python script from the link in that section. The script requires Python 3.8.10 or compatible. Move the uclusionCLI.py to ~/.local/bin or any other location on your path. Then make executable:

chmod +x uclusionCLI.py

Sync comment format

Any valid TODO that includes this format will be synced. Any uclusion.txt with a sources directory root will also have all notes with this format synced.

| [BUG (default) or JOB] [type] comment 
Case insensitive
for BUG, type is one of CRITICAL, NORMAL, or MINOR with default MINOR
for JOB, type is one of WAITING, READY, BACKLOG_READY, or BACKLOG_NOT_READY with default BACKLOG_NOT_READY

for example

// TODO | This is my bug

creates a minor bug in Uclusion. However

// TODO This is my bug

will not sync at all because the | is missing. Similarly, in a uclusion.txt file:

| This is my bug
| JOB - This is a job

will create a minor bug and a backlog not ready job.

// TODO | JOB READY This is my job

Will create a job in Work Ready stage assigned to the user that created the credentials file.

Running Uclusion CLI

In the same directory as your uclusion.json run

uclusionCLI.py

After completion, uclusion.txt will have the text starting with | and ending with your description replaced by the URLs of the created jobs and bugs.

Similarly

// TODO | JOB READY This is my job

becomes

// TODO J-Engineering-3 This is my job

where ‘J-Engineering-3’ is the short code of the created job.