Setup Oracle SQLcl Action

Sets up the Oracle SQLcl command line tool. This action locates a given version of Oracle SQLcl, downloads it, and configures the PATH environment variable so that SQLcl can be invoked via sql. An environment variable SQLCL_HOME also points to the location where the given SQLcl version was installed.

Supported platforms:

• Linux

• MacOS

• Windows

Inputs

Following inputs may be used as step.with keys:

Name	Required	Default	Description
version		latest	A valid version of SQLcl from the download site.
setup-java-version		21	Automatically setup Oracle JDK with the chosen version. Set to false to skip it.

The action accepts version: latest to download Oracle’s current SQLcl build, or a fully qualified release in the form nn.n.n.nnn.nnnn, such as 25.3.0.274.1210.

ℹ️	If you decide to skip the automatic Java setup then you’ll be responsible for configuring Java with version 11 as a minimum. Newer SQLcl releases require Java 17 and later. We recommend using actions/setup-java.

Usage

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: gvenzl/setup-oracle-sqlcl@v1
      - name: Run SQLcl
        run: |
          ${SQLCL_HOME}/bin/sql <arguments>

Versions

Use version: latest (default & recommended) to always pull the latest release of SQLcl or use an explicit version of SQLcl to pin it for reproducible builds. The latter is advisable especially when using the action in SQLcl project workflows to pin the SQLcl version to the one used in your configuration.