hci effect run

hci effect run [OPTIONS] ATTRIBUTE

Run an effect locally.

Parameters

ATTRIBUTE

The attribute path that leads to the effect. Tab completion is sensitive to --as-branch and such, so you want to specify that first.

--as-branch BRANCH

Pretend we’re on another git branch. This sets the src.ref attribute appropriately.

--as-ref BRANCH

Pretend we’re on another git ref. This sets the src.ref attribute appropriately.

--no-token

Don’t get an API token. Disallows access to state files, but can run in untrusted environment or unconfigured repo.

This does not inhibit use of a token provided via the HERCULES_CI_API_TOKEN variable.

--project PROJECT

Project path, e.g. github/my-org/my-project. Default: auto-detected.

Implicit inputs

This command uses git metadata from the working directory, unless --as-ref BRANCH (or similar) and --project PROJECT are specified.

Values for secrets are looked up in a local secrets.json or from HERCULES_CI_SECRETS_JSON.

Hercules CI API access is affected by the optional HERCULES_CI_API_BASE_URL and HERCULES_CI_API_TOKEN.