The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
aiAgent: Run AI Agentagent (optional)
antigravityclaudeCodecodexadditionalExecArgs : String (optional)
codex exec --ephemeral --json --skip-git-repo-check and before the prompt. Use this for exec flags such as --ignore-user-config, --ignore-rules, --add-dir path, --output-schema schema.json, or --color never. Arguments are split on whitespace.
additionalGlobalArgs : String (optional)
codex and before exec. Use this for global Codex flags such as --search, --profile ci, -c key=value, --enable feature, or --image path.png. Arguments are split on whitespace. Keep secrets in Jenkins credentials or config, not here.
customConfigEnabled : boolean (optional)
~/.codex/config.toml from the configured content. This is useful for per-build Codex settings and MCP configuration.
customConfigToml : String (optional)
~/.codex/config.toml. Stored in job configuration as plain text. Keep secrets in Jenkins credentials.
cursorgrokkiroompopenCodepiapiCredentialsId : String (optional)
ANTHROPIC_API_KEY, OPENAI_API_KEY, CURSOR_API_KEY, GEMINI_API_KEY, XAI_API_KEY). If empty, the build uses credentials already present on the node. Antigravity CLI uses node-level Google authentication by default and has no default API key environment variable. Authenticate the Jenkins service account before running a job. For Oh My Pi, set API Key env var override to the variable expected by the configured provider, such as OPENAI_API_KEY.
apiEnvVarName : String (optional)
OPENAI_API_KEY.
approvalTimeoutSeconds : int (optional)
commandOverride : String (optional)
disableInteractive : boolean (optional)
environmentVariables : String (optional)
KEY=VALUE format, one per line. Lines starting with # are ignored. These values are stored in plain text in job configuration.
executablePath : String (optional)
$HOME/.local/bin/codex. When empty, Jenkins resolves the default executable from the build node PATH. Interactive shell startup files are not loaded. Command override takes precedence over this setting.
extraArgs : String (optional)
--max-budget-usd 5 or --effort high. Arguments are split on whitespace. During ACP approval runs, the handler may reposition or ignore arguments that are incompatible with ACP or manual approvals. For Oh My Pi, Jenkins reserves execution, output, and session flags, CLI help/version/export/alias options, and --acp-terminal-auth in every mode. Read-only and ACP approval jobs also reserve approval and extension-loading options, including --plugin-dir. Read-only jobs reserve tool-list options; ACP approval jobs reserve config-file options. YOLO jobs allow OMP-specific tool, extension, and config options.
failOnAgentError : boolean (optional)
model : String (optional)
claude-sonnet-4, gpt-5.5, gemini-2.5-pro, grok-4.5). For Codex, Claude Code, and OpenCode, append a recognized reasoning effort with a colon, such as gpt-5.6-sol:xhigh. Antigravity CLI and Grok Build accept low, medium, and high, such as grok-4.5:high. Other colon suffixes remain part of the model identifier. Use a double colon to keep a recognized suffix literal, such as provider/model::high for model provider/model:high. The separate Reasoning effort field overrides the shorthand. Pi Coding Agent accepts a provider-qualified model, such as openai/gpt-5.5:xhigh. Oh My Pi accepts provider-qualified model identifiers, such as openai/gpt-5.5. Leave empty to use the agent's default model.
prompt : String (optional)
reasoningEffort : String (optional)
model_reasoning_effort, Claude Code maps it to --effort, OpenCode maps it to --variant, and Antigravity CLI maps it to --effort. Grok Build maps it to --reasoning-effort. Pi Coding Agent maps it to --thinking and accepts off, minimal, low, medium, high, xhigh, and max, subject to model support. Oh My Pi maps it to --thinking and also accepts auto, subject to model support. Common values include low, medium, high, xhigh, and max. Codex also supports ultra on compatible models, OpenCode supports minimal, and Antigravity CLI and Grok Build currently accept low, medium, and high. You can instead append a recognized value to the model, such as gpt-5.6-sol:xhigh. This field takes precedence over that shorthand. Unsupported agents ignore this field.
requireApprovals : boolean (optional)
always-ask policy. An inherited deny becomes a Jenkins approval decision for calls gated by OMP, while provider settings remain in effect.
setupScript : String (optional)
/bin/sh -e, so use POSIX syntax such as . file. Add #!/bin/bash or #!/bin/zsh before using shell-specific syntax such as source. This is currently supported on Unix agents only.
workingDirectory : String (optional)
yoloMode : boolean (optional)
--approval-mode yolo. With YOLO off, only read, grep, and glob are enabled and the write approval mode is used. Extension discovery is disabled by the built-in command in both modes.
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.