aiAgent: Run AI Agent

• agent (optional)
  Nested Choice of Objects
  • claudeCode
  • codex
    • additionalExecArgs : String (optional)
      Extra arguments inserted after codex exec --json --skip-git-repo-check and before the prompt. Use this for exec flags such as --ephemeral, --ignore-user-config, --ignore-rules, --add-dir path, --output-schema schema.json, or --color never. Arguments are split on whitespace.
    • additionalGlobalArgs : String (optional)
      Extra arguments inserted after 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)
      When enabled, the plugin writes a build-scoped ~/.codex/config.toml from the configured content. This is useful for per-build Codex settings and MCP configuration.
    • customConfigToml : String (optional)
      TOML content equivalent to ~/.codex/config.toml. Stored in job configuration as plain text. Keep secrets in Jenkins credentials.
  • cursor
  • geminiCli
  • openCode
• apiCredentialsId : String (optional)
  Select a Secret Text credential containing the API key for this agent. The key is injected as the expected environment variable for the selected agent (for example: ANTHROPIC_API_KEY, OPENAI_API_KEY, CURSOR_API_KEY, GEMINI_API_KEY). If empty, the build uses credentials already present on the node.
• apiEnvVarName : String (optional)
  Override the environment variable name used to inject the API key credential. Leave empty to use the selected agent default. Useful when an agent supports multiple provider variable names.
• approvalTimeoutSeconds : int (optional)
  Maximum number of seconds to wait for an approval decision before the build is failed. Only used when Require manual approvals is enabled. The default is 600 seconds (10 minutes).
• commandOverride : String (optional)
  Overrides the built-in agent command with a single shell command or shell snippet. This runs via the platform shell, so use the Setup script field for multiline setup. Line breaks are normalized to spaces when the job configuration is saved.
• disableInteractive : boolean (optional)
• environmentVariables : String (optional)
  Extra environment variables in KEY=VALUE format, one per line. Lines starting with # are ignored. These values are stored in plain text in job configuration.
• extraArgs : String (optional)
  Additional command-line arguments appended to the default agent command. For example --max-budget-usd 5 or --effort high. Arguments are split on whitespace.
• failOnAgentError : boolean (optional)
  When checked, the Jenkins build is marked as failed if the agent process exits with a non-zero exit code. When unchecked, a non-zero exit code is logged but the build continues.
• model : String (optional)
  The model identifier to pass to the AI agent (for example claude-sonnet-4, o3, gemini-2.5-pro). Leave empty to use the agent's default model.
• prompt : String (optional)
  The text prompt sent to the AI agent. Supports multi-line input. Build parameters and environment variables can be referenced in the prompt when using a Command override.
• reasoningEffort : String (optional)
  Optional reasoning effort for agents that support it. Codex maps this to model_reasoning_effort, Claude Code maps it to --effort, and OpenCode maps it to --variant. Common values include low, medium, high, xhigh, and max. Unsupported agents ignore this field.
• requireApprovals : boolean (optional)
  When enabled, the build pauses each time the agent requests a tool call (shell command, file edit, etc.) and waits for manual approval or denial through the Jenkins UI before continuing.
• setupScript : String (optional)
  Runs before the agent command and shares the same shell session, so exported variables flow into the agent process. This is currently supported on Unix agents only.
• workingDirectory : String (optional)
  Subdirectory relative to the workspace where the agent process runs. Leave empty to use the workspace root.
• yoloMode : boolean (optional)
  Skips all permission checks and approval prompts inside the agent, allowing it to execute tools (file edits, shell commands, etc.) without confirmation. Use with caution — the agent will have unrestricted access to the workspace.