jenkins-cli

jk is a cross-platform CLI tool that brings GitHub CLI's familiar command structure to Jenkins automation. It enables developers and operators to inspect runs, stream logs, manage credentials, and administer Jenkins controllers without relying on the web UI. The tool supports context-aware authentication across multiple Jenkins controllers, scriptable output in JSON/YAML with jq and templating support, and discovery-first job filtering with parameter grouping. Job provisioning focuses on Bitbucket-backed Multibranch Pipeline creation, raw config.xml inspection, and Jenkinsfile path management. Key platform operations include node cordoning, credential management, queue inspection, and plugin visibility.

[{"step":"Install the Jenkins CLI tool. If using a package manager, run `brew install jenkins-cli` (macOS) or `scoop install jenkins-cli` (Windows). Alternatively, download the JAR from your Jenkins instance at `https://<JENKINS_URL>/jnlpJars/jenkins-cli.jar`.","tip":"Ensure you have Java 8+ installed. The CLI uses the same authentication as the web UI, so configure your credentials once and reuse them across sessions."},{"step":"Configure the Jenkins instance URL and authentication. Run `jenkins-cli config set instance https://jenkins.company.com` and `jenkins-cli config set user <USERNAME> --password <API_TOKEN>`.","tip":"Generate an API token in Jenkins under 'User Settings' > 'Configure' > 'API Token'. Store it securely or use environment variables for automation."},{"step":"Execute commands directly from the terminal. Use `list-jobs`, `trigger-build`, `get-logs`, or `pause-job` based on your needs. Combine with shell tools like `grep`, `jq`, or `awk` for advanced filtering.","tip":"Use `--help` with any command to see available options. For example, `jenkins-cli trigger-build --help` shows how to pass parameters or wait for build completion."},{"step":"Integrate with scripts or CI/CD pipelines. For example, use the CLI in a GitHub Actions workflow to trigger Jenkins jobs or fetch logs after a deployment.","tip":"Wrap CLI commands in scripts to standardize operations. For instance, create a `jenkins-ops.sh` script with functions for common tasks like `deploy-prod` or `rollback`."},{"step":"Monitor and debug builds. Use `get-logs` with `--tail` to stream logs in real-time, or `get-build-info` to check build status and artifacts.","tip":"For large logs, use `--max-lines` to limit output or pipe to `less` for easier navigation. Combine with `grep` to filter for errors or warnings."}]