hci effect run
hci effect run [OPTIONS] ATTRIBUTE
Run an effect locally.
This commands pulls context from the repository and the Hercules CI API. See Implicit inputs.
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.
--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.
--pretend-branch BRANCH
Pretend we’re on another git branch. This sets parameters like ref and branch and src.ref to match BRANCH value.
Since hci 0.3.6. Older versions have --as-branch.
--pretend-ref REF
Pretend we’re on another git ref. This sets parameters like ref and branch and src.ref to match REF value.
Since hci 0.3.6. Older versions have --as-ref.
--project PROJECT
Project path, e.g. github/my-org/my-project. Default: auto-detected.
Parameter aliases
These aren’t technically deprecated yet, to ensure that the alternative is available to everyone when the time to switch comes. You may switch away from these on your own initiative.
--as-branch BRANCH
Alias for --pretend-branch BRANCH.
--as-ref BRANCH
Alias for --pretend-ref REF.
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.
Information such as the project id are looked up through the Hercules CI API.
Hercules CI API access is affected by the optional HERCULES_CI_API_BASE_URL and HERCULES_CI_API_TOKEN.