A CLI tool to manage and have fun with Jenkins server
Project description
yojenkins
yojenkins
is a cross-platform command line interface (CLI) tool to monitor, manage, and have fun with a Jenkins server. It makes it possible to interact with a Jenkins server without using the browser based Jenkins UI.
This tool is able to be integrated into a script as middleware in order to automate Jenkins related tasks or enable Jenkins configuration as code.
yojenkins
will liberate you and your browser from the Jenkins Web UI
With yojenkins
you can manage:
- Authentication: Authentication structure similar to AWS CLI
- Server: Create, shutdown, view queue, and more
- User accounts: Create, delete, add/remove permission, and more
- Nodes/agents: Create, delete, shut down server, and more
- Credentials: Create, update, delete, list, and more
- Folders: Create items, delete items, disable, enable, and more
- Jobs: Create, delete, trigger, monitor, search, and more
- Builds: Monitor, abort, tail logs, follow logs, and more
- Stages: Get info, get logs, view steps, view status
- Steps: Get info
- Other tools and functions: Run groovy scripts remotely, run custom REST calls, setup a shared library, view command usage history, and more
NOTE: This project is in alpha release phase. Please report any issues, odd behavior, or suggestions. Read more about the release cycle. See Bug Reports and Feature Requests
Overview
- Overview
- Quick Start
- Installation
- Usage
- Jenkins Plugin Requirements
- Local Jenkins Server Setup Using Docker
- Bug Reports
- Feature Requests
- Contributing
- Licence
Quick Start
-
(Optional) Start up a local Jenkins server using Docker
-
yojenkins server server-deploy
-
-
Configure your first profile. Profiles are stored in the home directory in
.yojenkins
-
yojenkins auth configure
-
-
Generate a Jenkins server API token and add it to your first profile
-
yojenkins auth token --profile <PROFILE NAME>
-
-
Verify that you can access the Jenkins server
-
yojenkins auth verify
-
-
Now start trying some things
-
Get sever info: yojenkins server info Get your user info: yojenkins auth user --pretty Search a job: yojenkins job search some-job-name --fullname --yaml --list Monitor a build: yojenkins build monitor some-job-name --latest --sound
-
Installation
-
Install system dependencies for
simpleaudio
sound Python package for job and build monitor-
Platform Command MacOS and Windows Not needed Ubuntu sudo apt update && apt-get install -y python3-dev python3-pip libasound2-dev
CentOS sudo yum update && yum install -y python3-devel gcc alsa-lib-devel
-
-
Install
yojenkins
-
Option 1 (Recommended): Install from Python Package Index (PYPI) using
pip
-
pip install yojenkins
-
-
Option 2: Download all files from this GitHub repository and install using the included
setup.py
-
python setup.py install
-
-
Option 3: Download pre-compiled binary from this GitHub repository
-
Usage
Each top level command has its sub-commands. For example, yojenkins server
has sub-command info
. To see the sub-commands of a top level command, or to see the options of any command, use the --help
option.
YOJENKINS (Version: 0.0.54)
yojenkins is a tool that is focused on interfacing with a Jenkins server from
the comfort of the beloved command line. This tool can also be used as a
middleware utility, generating and passing Jenkins information or automating
tasks.
QUICK START:
1. Configure yo profile: yojenkins auth configure
2. Add yo API token: yojenkins auth token --profile <PROFILE NAME>
3. Verify yo creds: yojenkins auth verify
4. Explore yojenkins
Options:
-v, --version Show the version
--help Show this message and exit.
Commands:
account Manage user accounts
auth Manage authentication and profiles
build Manage builds
credential Manage credentials
folder Manage folders
job Manage jobs
node Manage nodes
server Manage server
stage Manage build stages
step Manage stage steps
tools Tools and more
Jenkins Plugin Requirements
If you are using yojenkins
on a pre-existing Jenkins server, make sure that the following Jenkins plugin are installed for yojenkins
to use all its functionalities. However, these plugins tend to be installed by default.
- Folders (cloudbees-folder)
- Next Build Number (next-build-number)
- Promoted Builds (promoted-builds)
- Role-based Authorization Strategy (role-strategy)
- GitHub Branch Source Plugin (github-branch-source)
In order to check/install a plugin, you can:
- In the Jenkins UI, go to Manage Jenkins > Manage Plugins > Installed OR Available
yojenkins server plugins --pretty
Local Jenkins Server Setup Using Docker
yojenkins
offers an easy way to quickly set up a local Jenkins server within a Docker container. This server is setup and ready to go to tinker with yojenkins
.
WARNING: This server is for development, training, or testing purposes only. Do not use this server for production use. NOTE: You must have Docker installed and running. See Docker installation guide.
Run the following command to set up a local and containerized Jenkins server:
yojenkins server server-deploy
Use --help
for available options, and use --debug
to troubleshoot any issues.
Bug Reports
As with any other software, issues do come up during various usage scenarios that may not be accounted for during development and testing. Help from real users is enormously helpful.
Please report bugs and odd behaviors with:
- Online at GitHub Issues
yojenkins tools bug-report
If possible, please include the command that caused the issue. You can do this by running the command with the --debug
option. For example, yojenkins server info --debug
Feature Requests
This is a very young project, and we are always looking for new features and improvements. Please feel free to open an issue and suggest a feature. Please include as much information as possible.
- Online at GitHub Feature Request
yojenkins tools feature-request
Contributing
This project is an on-going effort, slowly adding various features and improvements. If you would like to contribute, please fork the project, make your changes, and submit a pull request.
Any help, ideas, or user testing is much appreciated!
There is definitely work to be done. If you spot an issue you are able to fix, or if you are eying a open issue or feature request, feel free to submit some code.
For guides and information on how to get started and help out, check out the dev_things
directory.
Contributors
- Ismet Handžić: GitHub: @ismet55555
Licence
This project is licensed under the GNU General Public License Version 3 License. Please see the LICENSE file for details. Also a complete history of this licence.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for yojenkins-0.0.54-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 818f07e37873ecdb1868dab190e97dc850f32cf834e08c7a9a83def455c5acc7 |
|
MD5 | 57822a77e121f01d1ee485bc9f318551 |
|
BLAKE2b-256 | b8f95a0126aaa07d36be9a2306b61e6f4d07859d82932a523d1808af3dff259e |