Commands
Reference for raptor, the Facets CLI.
Raptor is a kubectl-style CLI. Commands are organized into action verbs (get, create, apply, set, delete, describe, plan) acting on resource categories.
For the authoritative command reference, see Facets-cloud/raptor-releases. For inline, in-terminal help:
raptor --help # Top-level command list
raptor <command> --help # Flags and examples for any subcommand
raptor blueprint-guide # Embedded design guide for blueprintsCommand groups
| Category | Purpose | Examples |
|---|---|---|
| Authentication | Log in and inspect identity | login, whoami, auth can-i |
| Projects & types | Manage projects and project types | get projects, import project-type, create project-type |
| Resources (blueprint) | Add and update resources | apply resource, get resources, delete resource |
| Overrides | Per-environment configuration | apply override, get overrides, delete override |
| Plan & deploy | Validate and roll out changes | plan, create release, logs release, abort release |
| Environments | Provision and tear down environments | create environment, launch environment, destroy environment |
| Artifact CI | Register container images and zip bundles | create artifact, set artifact-uri, set artifact-zip, get artifacts, get artifact-uris |
| Registries | Container registry credentials | get registries, get registry-credentials |
| Modules (IaC) | Author and publish Terraform modules | module init, module set-spec, create iac-module, publish iac-module |
| Variables & secrets | Project configuration values | get variables, create variable, set variable |
| Discovery | Schema and expression lookup | describe module, describe expressions, get resource-types |
| Impact | Dependency analysis | impact <kind>/<name>, impact ... --reverse |
| Users & access | RBAC, users, groups, roles | get users, create user, apply role |
| Accounts | Cloud and VCS integrations | create account, create github-account, get accounts |
Run raptor <command> --help on any item above for full flags, examples, and aliases.
CI/CD workflows
The most common use of the CLI is in a CI pipeline that builds a container image and registers it as a Facets artifact. See Integrating with CI pipelines for the end-to-end build, push, register, deploy flow.
Self-update
Raptor can update itself in place:
raptor upgrade