Commands¶
allez has six verbs. Four go through the Fabric CLI (fab) and take --plan; allez audit and allez document never touch Fabric at all.
| Command | Loop | Does |
|---|---|---|
allez apply |
Development | Per-item fab import + fab api verify into the branch workspace. |
allez deploy |
Deployment | Whole-folder fab deploy in dag order, with hooks and $allez.* resolution. Promotion between environments. |
allez audit |
Deployment | Does parameter.yml cover every environment-specific id? Offline; JUnit for a pull request check. |
allez provision |
Lifecycle | Create and configure the branch workspaces for this branch. |
allez teardown |
Lifecycle | Delete the branch workspaces for this branch, or every orphaned one. |
allez document |
Development | The solution document as JSON on stdout: the plan's data, the audit's findings and each rule's matches. The VS Code extension reads it. Offline. |
Conventions¶
PATH: Solution root (fabric/) or a single workspace sub-folder. Default ..
--env: an environment declared in the root allez.yml environments: list. A name that is not declared is a load error.
--plan: changes nothing in Fabric and resolves no secret. It prints the fab calls a real run would make. apply --plan, deploy --plan and provision --plan need no credentials. Workspace ids come from .allez/cache/, a git-ignored cache that is safe to delete; where an id is not cached, deploy --plan prints the placeholder <workspace id of <name>> in its place. Only --plan reads that cache; a live run finds every workspace by name and records no id.
Exit codes: 0 on success, non-zero on any failure, so an agent or a pipeline can branch on them.
Auth: whatever fab is signed in as (fab auth login). allez has no credential code of its own.