Trellis is a TUI for viewing Jira Tickets and GitHub Pull requests.
It is written in Zig and uses the notcurses library.
This tool is very opinionated and is suited towards my specific workflows. If your use case is different, feel free to fork the project, create a pull request, or file feature requests. If I am able to make changes that are generic enough I am more than happy to incorporate them into the main project.
To build Trellis, you will need the following dependencies:
- Zig v0.15.1
- Notcurses
Build the project with the following command:
zig build --release=safe
After building, you should run trellis init to generate a config file.
You can run trellis open to open the config directory in your file browser.
The config file is a simple JSON file that contains the following fields:
base_url: URL of company's Atlassian instance (e.g., https://mycompany.atlassian.net)
user: Atlassian username (usually your email)
exclude_statuses: Array of status fields to exclude from the list of tickets
fields: Array of custom fields to display in the list of tickets.
Ex. ["summary", "description", "status", "priority"]
fields_custom_names: mappin of field name to a custom display name
display_order: Array of JIRA fields to display in the order you want them to be displayed
jira_token: Token for Atlassian API
github_token: Token for GitHub API
utc_offset: Integer offset for GitHub's UTC timestamps
After filling out the config file, you can run trellis to start the TUI!