jenkins-tui
is a terminal based user interface for Jenkins.
๐ง โ ๏ธ This app is a prototype and in very early stages of development. There will be bugs, bad UX and missing functionality.
๐ This project is powered by textual and rich!
jenkins-tui
is available on pypi.org!
pip install jenkins-tui
Once the app is installed you can run it from your terminal with the jenkins
command.
jenkins
Alternatively, you can run the app with docker to keep your local dependencies squeaky clean ๐งน
docker run --rm -it --volume $HOME:/jenkins ghcr.io/chelnak/jenkins-tui:latest
On first run you will be asked for some information so that the app can build your configuration file.
You'll need to enter a url for your Jenkins instance along with a username and password.
Alternatively you can manually pre-load a config file at ~/.jenkins-tui.toml
and use the following schema:
# .jenkins-tui.toml
url = ""
username = ""
password = ""
This project has been tested on macOS and Linux (Arch, Ubuntu 20.04 and above) with Python 3.9 installed. It will likely work on any Linux distribution where Python 3.9 or above is available.
For Ubuntu 20.04, it may be necessary to install the python3.9
package.
If you would like to contribute to jenkins-tui
head over to the contributing guide to find out more!