Skip to content

RUNNING.md

Latest commit

 

History

History
134 lines (95 loc) · 3.23 KB

RUNNING.md

File metadata and controls

134 lines (95 loc) · 3.23 KB
Raw

Running Conductor Examples

Every example in this repository follows the same structure and can be run the same way.

Prerequisites

  • Java 21+: verify with java -version
  • Maven 3.8+: verify with mvn -version
  • Node.js and npm: for the recommended local Conductor CLI

Option 1: Conductor CLI (recommended)

Install the Conductor CLI, start the server, and then run an example:

npm install -g @conductor-oss/conductor-cli
conductor server start

cd examples/<category>/<example>
mvn package -DskipTests
java -jar target/<example>-1.0.0.jar

Stop the server when finished with conductor server stop.

Option 2: Docker Compose

Each example includes a docker-compose.yml that starts both Conductor and the example:

cd examples/<category>/<example>
docker compose up --build

Conductor UI will be available at http://localhost:1234.

Option 3: Docker container

Start Conductor:

docker run -d -p 8080:8080 -p 1234:5000 conductoross/conductor:latest

Build and run the example:

cd examples/<category>/<example>
mvn package -DskipTests
java -jar target/<example>-1.0.0.jar

Option 4: Launcher Script

cd examples/<category>/<example>
./run.sh

The script auto-detects CONDUCTOR_SERVER_URL or defaults to http://localhost:8080/api.

Worker-Only Mode

Start workers without running the workflow (useful with CLI or UI):

java -jar target/<example>-1.0.0.jar --workers

Using the Conductor CLI

With workers running in --workers mode, use the CLI to start workflows:

conductor workflow start \
  --workflow <workflow_name> \
  --version 1 \
  --input '{"key": "value"}'

Check status:

conductor workflow get-execution <workflow_id>

AI coding agents

Install Conductor Skills to give a supported coding agent Conductor workflow and operations guidance:

npm install -g @conductor-oss/conductor-skills
conductor-skills --all

Configuration

Environment Variable Default Description
CONDUCTOR_SERVER_URL http://localhost:8080/api Conductor server URL
CONDUCTOR_PORT 8080 Host port for Conductor (Docker Compose only)

SDK Dependency

All examples use conductor-oss Java SDK v5:

<dependency>
    <groupId>org.conductoross</groupId>
    <artifactId>conductor-client</artifactId>
    <version>5.0.1</version>
</dependency>

Project Layout

Every example follows this layout:

<example>/
├── pom.xml                    # Maven build (Java 21)
├── run.sh                     # Launcher script
├── README.md                  # What this example does
├── Dockerfile                 # Multi-stage build
├── docker-compose.yml         # Conductor + workers
├── src/main/java/
│   ├── *Example.java          # Main class
│   ├── ConductorClientHelper.java
│   └── workers/               # Worker implementations
├── src/main/resources/
│   └── workflow.json          # Workflow definition
└── src/test/java/
    └── workers/               # Unit tests