Skip to main content
The oleander CLI lets you manage Spark artifacts and jobs, run SQL queries against the lake, browse catalogs, register infrastructure, and launch a DuckDB terminal from the command line.

​
Installation

​
Using Homebrew

Install the oleander CLI: 
brew tap OleanderHQ/tap
brew install oleander-cli
Upgrade to the latest version: 
brew update
brew upgrade oleander-cli

​
Using APT on Ubuntu

  1. Install required packages for secure repository setup:
apt-get update
apt-get install -y curl ca-certificates gnupg
  1. Add the oleander APT signing key:
curl -fsSL https://oleander-cli-releases.s3.amazonaws.com/keys/oleander-archive-keyring.gpg \
  | tee /usr/share/keyrings/oleander-archive-keyring.gpg >/dev/null
  1. Add the oleander APT source:
tee /etc/apt/sources.list.d/oleander.sources >/dev/null <<'EOF'
Types: deb
URIs: https://oleander-cli-releases.s3.amazonaws.com/apt
Suites: stable
Components: main
Signed-By: /usr/share/keyrings/oleander-archive-keyring.gpg
EOF
  1. Update package indexes and install the CLI:
apt-get update
apt-get install -y oleander-cli

​
Configuration

Authenticate with your API key. Find it in your oleander settings. 
oleander configure --api-key <YOUR_API_KEY>
You can also run oleander configure without flags to enter your key interactively. The CLI stores the API key in ~/.oleander/config.json.

​
Commands

CommandDescription
oleander configureSet your API key
oleander spark initInitialize a PySpark job workspace
oleander spark jobs listList uploaded Spark artifacts
oleander spark jobs uploadUpload a Spark artifact
oleander spark jobs deleteDelete a Spark artifact
oleander spark jobs submitSubmit a Spark job
oleander spark clusters listList registered Spark clusters
oleander spark clusters registerRegister an external Spark cluster
oleander queryRun a SQL query against the lake
oleander catalogs listList available catalogs
oleander catalogs registerRegister an S3 Tables catalog
oleander catalogs tables listList tables in a catalog
oleander catalogs tables describeDescribe a table schema
oleander duckdbLaunch a DuckDB terminal connected to your lake
See Spark and Lake for detailed usage.