Skip to content

Qaze CLI

Use qaze tc when you want fast, repeatable runs from your terminal.

When The CLI Is Useful

  • Before a commit: validate manifests quickly
  • In CI: fail builds when checks fail
  • For smoke tests: run a tagged subset only
  • For debugging: preview and run one manifest directly

First CLI Session

bash
qaze tc ping
qaze tc validate .
qaze tc run . --dry-run
qaze tc run .

Practical Examples

Run only smoke tests

bash
qaze tc run . --tag smoke

Run only publish checks

bash
qaze tc run . --kind Publish

Run one manifest while debugging

bash
qaze tc validate publish-orders.yaml
qaze tc preview publish-orders.yaml
qaze tc run publish-orders.yaml

Produce JSON output for CI artifacts

bash
qaze tc run . --output json --output-file qaze-results.json

Configure Connections

You can provide connection data using:

  1. CLI flags
  2. qaze.config.yaml
  3. Environment variables

If the same value is set in multiple places, CLI flags win.

Config File

Create a starter file:

bash
qaze config init

Example qaze.config.yaml:

yaml
connections:
  - id: default
    name: My Connection
    work:
      server: nats://localhost:4222
    # sys:
    #   creds: /path/to/sys.creds

Use a specific config connection:

bash
qaze tc run . --connection-id default

Common Environment Variables

  • QAZE_TESTING_CLIENT_SERVER
  • QAZE_TESTING_CLIENT_CONTEXT
  • QAZE_TESTING_CLIENT_CREDS
  • QAZE_TESTING_CLIENT_NKEY
  • QAZE_TESTING_CLIENT_USER
  • QAZE_TESTING_CLIENT_PASSWORD
  • QAZE_TESTING_CLIENT_SYS_CONTEXT
  • QAZE_TESTING_CLIENT_SYS_CREDS
  • QAZE_TESTING_CLIENT_SYS_NKEY
  • QAZE_TESTING_CLIENT_SYS_USER
  • QAZE_TESTING_CLIENT_SYS_PASSWORD

Command Map

  • qaze tc run execute manifests
  • qaze tc validate lint/validate manifests only
  • qaze tc preview preview publish payload + subject
  • qaze tc list list manifests in a path
  • qaze tc tree show manifest tree
  • qaze tc init create collections or manifests
  • qaze tc ping verify NATS connectivity

Notes

  • qaze tc run supports Publish and Request.
  • qaze tc preview supports Publish manifests.
  • If a manifest uses useSystemAccount, configure system credentials (sys) in flags, config, or environment variables.
  • Use qaze tc --help and qaze tc <command> --help for full options.

Powered by Qaze