Skip to content
StackRivet Docs

CLI

The stackrivet-cli module is a thin CLI for tasks you run around the app rather than inside it. The Community edition ships the doctor command.

doctor

Section titled “doctor”

A fast pre-flight check of your environment and configuration:

  • Java — JDK 21 or newer is selected.
  • Storage — the configured STACKRIVET_STORAGE_TYPE is recognised, and for s3 / aliyun_oss that the endpoint and access/secret keys are present.
  • Database — STACKRIVET_DB_HOST is set (otherwise the active profile’s default is used).

It checks configuration presence so you can diagnose a fresh machine or a teammate’s setup before starting the app.

From source, build and run it like this:

Terminal window
cd stackrivet-server
./mvnw -pl stackrivet-cli -am package -DskipTests
java -jar stackrivet-cli/target/stackrivet-cli.jar doctor

For object storage, doctor follows the same environment variable families as the app: STACKRIVET_S3_* for s3, and STACKRIVET_ALIYUN_OSS_* for aliyun_oss.

Edition boundary

Section titled “Edition boundary”

The CLI stays small in Community. Live database/storage connectivity checks, toolchain checks, code-generation helpers and enterprise environment diagnostics are Pro / Enterprise; see the pricing page.