Security.RunDevelopers
v1 PreviewOpenAPI ↗
API & MCP reference/CALDERA: run an operation with a local agent
TOOL LIBRARY

CALDERA: run an operation with a local agent

Run an operation with a local agent.

1. Run the example

Download the CALDERA example. Extract it, install httpx, set your API URL and token, then run python client.py. The client uploads the included inputs, submits the command, and saves the result under results/RUN_ID.

2. Check the result

Read report.json and agents.json for the operation steps and agent result.

Read the native exit code and cleanup status printed by the client. Read results and save reports explains the returned files.

3. Use your own inputs

Edit example.json to change the command arguments, requested outputs or deadline. Replace the files under inputs/ with your own data, keeping the staged paths aligned with the command. The client creates the artifact IDs for you; illustrative IDs shown here must not be copied into a live request.

Files used by this example

  • run.py

The example uses supplied files or the disposable execution environment. Nothing from the environment carries into a later run unless you request and reuse its output.

Commands, version and prerequisites

Qualified version: 5.3.0-0kali2-sr1. Commands: caldera, python.

  • The Caldera server and plugins run within the disposable executor; operations need a compatible target/agent and supplied configuration.

Inspect GET /v1/tools/caldera for the current installed version and readiness. The published snapshot has 1 functional case(s), plus timeout and cancellation checks. These examples demonstrate the native path; other flags and inputs are supported within the tool’s runtime limits.

Search documentation, capabilities and native tools.

Copy this page

Your browser couldn’t copy automatically. Copy the selected Markdown below.