Skip to main content
The oleander CLI lets you manage Spark jobs, run SQL queries against the lake, browse catalogs, and launch a DuckDB terminal—all 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

​
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.

​
Commands

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