hashgraph-online/awesome-codex-plugins / plugins/avivsinai/jenkins-cli/skills/jk
jk
VerifiedManage Jenkins controllers with jk, including jobs, runs, logs, artifacts, credentials, nodes, queues, and plugins.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.1 KB |
| references/commands.md | markdown | 15.4 KB |
| rules/artifact.md | markdown | 1.8 KB |
| rules/auth.md | markdown | 3.1 KB |
| rules/context.md | markdown | 2.4 KB |
| rules/cred.md | markdown | 2.9 KB |
| rules/job.md | markdown | 7.5 KB |
| rules/node.md | markdown | 3.0 KB |
| rules/other.md | markdown | 3.6 KB |
| rules/plugin.md | markdown | 3.1 KB |
| rules/queue.md | markdown | 1.5 KB |
| rules/run.md | markdown | 12.5 KB |
| rules/test.md | markdown | 1.0 KB |
rules/run.md
View on GitHub<!-- auto-generated by cmd/docgen — do not edit -->
# jk run
Interact with job runs
```
jk run <command> [flags]
```
## Subcommands
| Subcommand | Description | Key Flags |
|---|---|---|
| [cancel](#jk-run-cancel) | Cancel a running job | `--mode` |
| [ls](#jk-run-ls) | List recent runs | `--agg`, `--cursor`, `--filter`, `--group-by` |
| [params](#jk-run-params) | Discover job parameter definitions | `--limit-runs`, `--source` |
| [rerun](#jk-run-rerun) | Rerun a job using the previous parameters | `--follow`, `--follow-interval`, `--interval`, `--result` |
| [search](#jk-run-search) | Search Jenkins jobs and runs across folders | `--filter`, `--folder`, `--job-glob`, `--limit` |
| [start](#jk-run-start) | Trigger a job run | `--follow`, `--follow-interval`, `--fuzzy`, `--interval` |
| [steps](#jk-run-steps) | Inspect Pipeline stage and step IDs, labels and state | — |
| [view](#jk-run-view) | View run details | `--exit-status`, `--interval`, `--result`, `--summary` |
| [watch](#jk-run-watch) | Wait for a commit's build, then follow it to completion | `--commit`, `--exit-status`, `--interval`, `--timeout` |
## jk run cancel
Cancel a running job
### Usage
```
jk run cancel <jobPath> <buildNumber> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--mode` | | Termination mode: stop, term, or kill |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
## jk run ls
List recent runs
### Usage
```
jk run ls <jobPath> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--agg` | | Aggregation function for grouped results: count, first, last |
| `--cursor` | | Cursor for pagination (use value from previous output) |
| `--filter` | | Filter runs (repeatable): key[op]value |
| `--group-by` | | Group results by field (e.g., param.CHART_NAME) |
| `--include-queued` | | Include queued (not yet started) builds in output |
| `--limit` | | Number of runs to list |
| `--regex` | | Enable regular expression matching for filters |
| `--select` | | Select additional fields (comma-separated) |
| `--since` | | Filter runs since timestamp or duration (RFC3339, 72h, 7d) |
| `--with-meta` | | Include metadata in JSON output |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
### Examples
```bash
# List recent runs for a job
jk run ls Helm.Chart.Deploy
# Filter by parameter values
jk run ls Helm.Chart.Deploy --filter param.CHART_NAME~nova --filter result=SUCCESS --since 7d
# Group by chart name and return the last run per chart
jk run ls Helm.Chart.Deploy --group-by param.CHART_NAME --agg last --json
# Select specific fields for agent consumption
jk run ls Helm.Chart.Deploy --select parameters --limit 5 --json --with-meta
```
## jk run params
Discover job parameter definitions
### Usage
```
jk run params <jobPath> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--limit-runs` | | Number of recent runs to scan when inferring parameters |
| `--source` | | Parameter source: auto, config, or runs |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
### Examples
```bash
# Infer parameters from job configuration
jk run params Helm.Chart.Deploy --source config --json
# Auto-discover parameters using the last 20 runs
jk run params Helm.Chart.Deploy --source runs --limit-runs 20
# Combine with jk run ls for an agent workflow
jk run ls Helm.Chart.Deploy --select parameters --filter param.CHART_NAME~nova --json
```
## jk run rerun
Rerun a job using the previous parameters
### Usage
```
jk run rerun <jobPath> <buildNumber> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--follow` | | Follow the rerun progress until completion |
| `--follow-interval` | | Polling interval when following runs |
| `--interval` | | Polling interval when waiting |
| `--result` | | Output only the final build result (requires --follow) |
| `--timeout` | | Maximum time to wait (0 = no timeout) |
| `--wait` | | Wait for build to complete (no log streaming) |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
## jk run search
Discover Jenkins jobs and runs without knowing exact folder paths. Combine job globs and run filters to home in on the builds you need.
### Usage
```
jk run search [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--filter` | | Filter runs (repeatable): key[op]value |
| `--folder` | | Folder path to search in |
| `--job-glob` | | Job glob pattern (e.g., "*/deploy-*") |
| `--limit` | | Max results to return |
| `--max-scan` | | Max builds to scan per job |
| `--regex` | | Enable regular expression matching for filters |
| `--select` | | Select additional fields (comma-separated) |
| `--since` | | Only search runs since timestamp or duration (RFC3339, 72h, 7d) |
| `--with-meta` | | Compatibility alias; structured search output already includes metadata |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
### Examples
```bash
# Discover job paths that contain "ada"
jk run search --job-glob "*ada*" --limit 5
# Find recent failed builds across a folder
jk run search --folder ci-jobs --filter result=FAILURE --limit 10
# Search for builds with specific parameter value
jk run search --job-glob "*/deploy-*" --filter param.ENVIRONMENT=production --since 7d
# Find builds by user across all jobs
jk run search --filter cause.user~john --select parameters --limit 5
```
## jk run start
Trigger a job run. If the job is not found, will automatically search for similar jobs.
Related commands:
jk search --job-glob '<pattern>' Search for jobs by pattern
jk job ls --folder '<folder>' List jobs in a folder
### Usage
```
jk run start <jobPath> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--follow` | | Follow the run progress until completion |
| `--follow-interval` | | Polling interval when following runs |
| `--fuzzy` | | Enable fuzzy matching for job names |
| `--interval` | | Polling interval when waiting |
| `--non-interactive` | | Disable interactive selection (fail on ambiguous matches) |
| `--param` | `-p` | Scalar build parameter NAME=VALUE (one flag per name) |
| `--param-list` | | Multi-value build parameter NAME=JSON_ARRAY (one flag per name) |
| `--result` | | Output only the final build result (requires --follow) |
| `--timeout` | | Maximum time to wait (0 = no timeout) |
| `--wait` | | Wait for build to complete (no log streaming) |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
### Examples
```bash
jk run start team/app -p ENV=staging --param-list 'DOMAINS=["a","b","c"]'
```
## jk run steps
Inspect stages and steps using the optional Pipeline Graph View plugin. Use a node ID with jk log --step to fetch its isolated log.
### Usage
```
jk run steps <jobPath> <buildNumber> [flags]
```
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
## jk run view
View run details
### Usage
```
jk run view <jobPath> <buildNumber> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--exit-status` | | Exit with code based on build result |
| `--interval` | | Polling interval when waiting |
| `--result` | | Output only the build result (e.g., SUCCESS, FAILURE) |
| `--summary` | | Show human-readable build summary |
| `--timeout` | | Maximum time to wait (0 = no timeout) |
| `--wait` | | Wait for build to complete (no log streaming) |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
## jk run watch
Watch the newest retained build of a full source commit SHA. Wait for a build if none exists yet, then follow that build number to completion. Queue entries before a matching build exists are job-level context and are not attributed to the commit.
### Usage
```
jk run watch <jobPath> --commit <sha> [flags]
```
### Flags
| Flag | Short | Description |
|---|---|---|
| `--commit` | | Full source commit SHA to watch (required) |
| `--exit-status` | | Exit with the final build result code |
| `--interval` | | Polling interval |
| `--timeout` | | Maximum total discovery and execution wait (0 = no timeout) |
### Inherited Flags
| Flag | Short | Description |
|---|---|---|
| `--context` | `-c` | Active Jenkins context name (or set JK_CONTEXT env var) |
| `--format` | | Output format: json, yaml |
| `--jq` | | Filter JSON output using jq expression (requires --json or --format=json) |
| `--json` | | Output in JSON format when supported |
| `--quiet` | `-q` | Suppress non-essential output |
| `--template` | `-t` | Format output using Go template (requires --json or --format=json) |
| `--yaml` | | Output in YAML format when supported |
### Examples
```bash
jk run watch team/app/main --commit 0123456789012345678901234567890123456789 --exit-status
jk run watch team/app/main --commit 0123456789012345678901234567890123456789 --timeout 20m --json
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |