Skip to main content

A Command line interface for Jenkins

Project description

jxctl

CircleCI (all branches) GitHub

codecov Coverage Quality Gate Status Bugs Vulnerabilities Lines of Code

PyPI PyPI - Python Version PyPI - Downloads

Libraries.io dependency status for specific release

Documentation Status

A Command line interface for Jenkins.

Installation

`pip install jxctl`

Commands

Command Description Usage
version Version and info about jxctl jxctl version
context Jenkins instance called as a context in jxctl. It provides set Jenkins context and infomation about the context jxctl context [OPTIONS] COMMAND [ARGS]...
get get provides you the functionality to get the resources like jobs, pluings, folders, builds list with count jxctl get [OPTIONS] COMMAND [ARGS]...
job job provides the functionalities like create, trigger build, job info, build info jxctl job [OPTIONS] COMMAND [ARGS]

context

Examples:
`jxctl context set --url <Jenkins URL>`
`jxctl context set --url <Jenkins URL> --name <Context Name> --user <Username> --token <Password/Access Token>`
`jxctl context info`

get

Examples:
`jxctl get jobs --all`
`jxctl get jobs --maven --freestyle --count`
`jxctl get pluings`

job

Examples:
`jxctl job <JOB NAME>`
`jxctl job <JOB NAME> --build`
`jxctl job <JOB NAME> --buildinfo <BUILD NUMBER>`

Current Work

Work Description Status
Job Implemention Job & Build functionality(Create, Trigger, Detail, Delete) InProgress
Testing Implement Test Cases, Suite InProgress
Handling Error Implement Exception Handling InProgress
Node Implement Node functionality ToDo
Report Implement Report functionality ToDo
Docs Document Generation ToDo

Contribution

We are happy to accept PR's. Those who are interested in contribution please have a look at below functional area's which are needed.

* Testing
* Docs
* Fine-Tuning

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jxctl-0.0.8b0.tar.gz (16.6 kB view hashes)

Uploaded Source

Built Distribution

jxctl-0.0.8b0-py3-none-any.whl (19.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page