Jk

---
name: jk
version: 0.0.37
description: Manage Jenkins controllers with jk, including jobs, runs, logs, artifacts, credentials, nodes, queues, and plugins.
metadata:
  short-description: Jenkins CLI for jobs, config, pipelines, and runs
  compatibility: claude-code, codex-cli
---

# Jenkins CLI

Use `jk` for Jenkins reads and changes. Inspect `jk --help` or a subcommand's
help when syntax is uncertain. Check installation or version only when the
command is unavailable or a requested feature has a known minimum version.

## Route the task

Read only the rule that matches the request:

- Authentication and SSO: [rules/auth.md](rules/auth.md)
- Saved controllers and context selection: [rules/context.md](rules/context.md)
- Jobs, folders, configuration, and scans: [rules/job.md](rules/job.md)
- Runs, parameters, reruns, and logs: [rules/run.md](rules/run.md)
- Artifacts: [rules/artifact.md](rules/artifact.md)
- Test reports: [rules/test.md](rules/test.md)
- Credentials: [rules/cred.md](rules/cred.md)
- Nodes: [rules/node.md](rules/node.md)
- Queue: [rules/queue.md](rules/queue.md)
- Plugins: [rules/plugin.md](rules/plugin.md)
- Other administrative commands: [rules/other.md](rules/other.md)

For exact flags and output modes, search
[references/commands.md](references/commands.md) for the subcommand.

## Shared operating rules

- Use the active context unless the user names another controller. Verify the
  target context before a state-changing or security-sensitive operation.
- Prefer structured output (`--json` or `--yaml`) when another tool or script
  will consume the result.
- Inspect a job's declared parameters before starting a parameterized run; do
  not guess names or values.
- Treat job configuration, credentials, nodes, plugins, queue cancellation,
  and run deletion as state-changing operations. Show the resolved target and
  follow the user's authorization.
- Never print, store, or echo Jenkins tokens or credential secrets. Browser SSO
  access tokens are not Jenkins API tokens; follow [rules/auth.md](rules/auth.md).
- Do not weaken TLS verification unless the user explicitly chooses that risk.

## Common reads

```bash
jk job ls
jk job view team/app
jk run ls team/app
jk run view team/app 128
jk log team/app 128 --follow
jk artifact ls team/app 128
jk test report team/app 128
jk queue ls
```

Use the relevant rule file before composing a write command.

## References

<!-- auto-generated by cmd/docgen — do not edit below this line -->

- [artifact](rules/artifact.md) — Work with run artifacts
- [auth](rules/auth.md) — Authenticate with Jenkins instances
- [context](rules/context.md) — Manage Jenkins contexts
- [cred](rules/cred.md) — Manage Jenkins credentials
- [job](rules/job.md) — Manage Jenkins jobs and pipelines
- [node](rules/node.md) — Inspect and manage Jenkins nodes
- [plugin](rules/plugin.md) — Inspect and manage Jenkins plugins
- [queue](rules/queue.md) — Inspect the build queue
- [run](rules/run.md) — Interact with job runs
- [test](rules/test.md) — Inspect test results
- [other](rules/other.md) — log, search, version

<!-- end auto-generated -->