Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oleander.dev/llms.txt

Use this file to discover all available pages before exploring further.

Run a PySpark job on oleander-managed infrastructure in a few minutes. Lineage, cost, and run context are captured automatically from the first execution.

​
Install the CLI

brew tap OleanderHQ/tap
brew install oleander-cli

​
Configure your API key

Authenticate with the API key from your oleander settings. 
oleander configure --api-key <YOUR_API_KEY>

​
Initialize a workspace

Create a new PySpark job workspace: 
oleander spark init my-job
cd my-job
The workspace includes entrypoint.py, a mylib/ package directory, and a Makefile for building deployable artifacts. Install dependencies and build: 
uv sync --dev
make
This produces out/pyfiles.zip and out/environment.tar.gz for upload.

​
Upload and submit

Upload your entrypoint and dependencies, then submit a run: 
oleander spark jobs upload entrypoint.py \
  --py-files out/pyfiles.zip \
  --virtualenv out/environment.tar.gz

oleander spark jobs submit entrypoint.py \
  --namespace my-namespace \
  --name my-first-job \
  --wait
When the run finishes, open Runs in the oleander app to inspect timing, lineage, and cost attribution.

​
Next steps

Spark jobs reference

Upload artifacts, submit runs, and register your own Spark clusters

CLI reference

Full oleander spark commands for init, upload, submit, and clusters