Installation

Run FedCLI from the platform you already use.

FedCLI ships as an interactive command-line tool. Use Docker or a cloud registry for an isolated runtime, Homebrew on macOS or Linux, npm for a host-visible fedcli command, or GitHub Actions for CI jobs.

Choose a delivery path

Docker and cloud registries

Use the public image for a zero-host-install CLI session, one-shot command, or mounted script. The same 1.0.4 image is available through Docker Hub, GitHub Container Registry, AWS, Azure, and Google Cloud.

Homebrew

Install the SHA-256-pinned release on macOS or Linux. The formula brings in Java 17.

npm

Install the launcher when you want fedcli on the host. Java 17 or newer is required.

GitHub Actions

Use the public Docker Action in an Ubuntu workflow without AWS or GHCR credentials.

Docker quick start

docker run --rm -it docker.io/ronwarshawsky/fedcli:latest
docker run --rm docker.io/ronwarshawsky/fedcli:latest -h
docker run --rm docker.io/ronwarshawsky/fedcli:latest -c "HELP"

For a script, mount only the file the command needs and execute it through the image entrypoint.

docker run --rm \
  -v "$PWD/ops-check.sql:/work/ops-check.sql:ro" \
  docker.io/ronwarshawsky/fedcli:latest \
  @/work/ops-check.sql

Pull the same release from your cloud registry

Use the registry closest to your deployment policy. Each command below selects the public FedCLI 1.0.4 image; replace the image name in the Docker examples above without changing the FedCLI command that follows it.

# GitHub Container Registry
docker pull ghcr.io/ronwarshawsky/fedcli:1.0.4

# AWS ECR Public
docker pull public.ecr.aws/c1t8q5x5/fedcli:1.0.4

# Azure Container Registry
docker pull fedclipublic.azurecr.io/fedcli:1.0.4

# Google Artifact Registry
docker pull us-docker.pkg.dev/enteros-upbeat/fedcli-public/fedcli:1.0.4

For example, start an AWS-hosted image interactively:

docker run --rm -it public.ecr.aws/c1t8q5x5/fedcli:1.0.4

For repeatable automation, pin the full image digest from the registry rather than a mutable tag.

Run FedCLI in GitHub Actions

The public Action builds from an immutable public GitHub Container Registry digest, so an ordinary GitHub-hosted Linux runner needs no AWS or GitHub Container Registry credentials.

steps:
  - uses: actions/checkout@v6
  - uses: applextech/fedcli-action@v1
    with:
      sql: SHOW LICENSE

For a checked-in script and a protected database URL, use GitHub Secrets:

steps:
  - uses: actions/checkout@v6
  - uses: applextech/fedcli-action@v1
    with:
      connection-url: ${{ secrets.FEDCLI_JDBC_URL }}
      script: sql/health.sql

See the Action repository for inputs, examples, release notes, and its Marketplace status.

Homebrew quick start for macOS and Linux

brew install applextech/tap/fedcli
fedcli --help

Homebrew automatically trusts this named formula, installs openjdk@17, and downloads the immutable 1.0.4 release JAR verified by SHA-256. Use brew upgrade fedcli after brew update to receive a later formula release. The legacy dbcli command remains available as a compatibility alias.

Review the official ApplexTech tap and the FedCLI 1.0.4 release for the binary, checksum, and license documents.

npm quick start

npm install -g @applextech/fedcli
fedcli -h

The launcher downloads and verifies the matching public runtime on first use, then reuses its local cache. For a project-local installation, use npx fedcli --fedcli-runtime-info or npm exec fedcli -- --fedcli-runtime-info.

Keep persistent state isolated

Docker starts with empty local state unless you mount a volume. Use one named volume per human or isolated environment; do not share aliases, drivers, credentials, licenses, or history between identities.

docker run --rm -it \
  -v fedcli-home-alice:/var/lib/fedcli \
  docker.io/ronwarshawsky/fedcli:latest

Release boundary: use docker run as a CLI invocation. The public image is not an always-on container service designed for later docker exec sessions.