Docs

Commands

Command reference for raptor, the kubectl-style Facets CLI: verbs and resource groups for projects, blueprints, releases, artifacts, and IaC modules.

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 blueprints

Command groups

CategoryPurposeExamples
AuthenticationLog in and inspect identitylogin, whoami, auth can-i
Projects & typesManage projects and project typesget projects, create project, get project-types, import project-type
Resources (blueprint)Add and update resourcesapply resource, get resources, delete resource
OverridesPer-environment configurationapply override, get overrides, delete override
Plan & deployValidate and roll out changesplan, create release, logs release, abort release
EnvironmentsProvision and tear down environmentscreate environment, launch environment, destroy environment
Artifacts & buildsRegister container images and zip bundles, and manage what is registeredcreate artifact, set artifact-uri, set artifact-zip, get artifacts, get builds, promote build, delete build
Delivery configurationDecide where a build lands: branch mapping and promotion ladderget ci-cd, set ci-cd, test ci-cd, attach artifact, detach artifact, get artifact-usages
RegistriesContainer registry credentialsget registries, get registry-credentials
Modules (IaC)Author and publish Terraform modulesmodule init, module set-spec, create iac-module, publish iac-module
Variables & secretsProject configuration valuesget variables, create variable, set variable
DiscoverySchema and expression lookupdescribe module, describe expressions, get resource-types
ImpactDependency analysisimpact <kind>/<name>, impact ... --reverse
Users & accessRBAC, users, groups, rolesget users, create user, apply role
AccountsCloud and VCS integrationscreate account, create github-account, get accounts

Run raptor <command> --help on any item above for full flags, examples, and aliases.

Two words that are easy to conflate: an artifact is the named CI integration a resource deploys from, and a build is one image or zip registered under it. create artifact and delete artifact act on the first; get builds, promote build and delete build act on the second. To find which artifact a resource deploys from, read the ARTIFACT column of raptor get resources -p PROJECT -o wide.

Validate before you release

raptor plan is the pre-release gate. Run it against a project and environment before you create a release, and read the output before you apply anything:

raptor plan -p PROJECT -e ENV

A plan runs pre-flight validation locally (expression resolution, dependency cycles, input wiring) and then requests a Terraform plan from the Control Plane, so you see both the configuration errors and the infrastructure changes the release would make.

Useful flags:

FlagWhat it does
--skip-server-planRuns local validation only and skips the server-side Terraform plan. Fastest way to check a blueprint edit.
--target KIND/NAMEPlans only the named resources, for example --target service/api. Repeat the flag for more than one.
--forceProduces a plan even when Facets detects no pending changes.
--allow-destroyAllows resource destruction in the plan.
-m, --messageAttaches a comment to the plan.
# Local validation only
raptor plan -p myproject -e dev --skip-server-plan

# Plan a single service, allowing resource destruction
raptor plan -p myproject -e dev --target service/api --allow-destroy

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

AI agent skills

Raptor embeds its own CLI skills, which teach an AI coding agent how to drive raptor itself. They come from the binary, so they match the version you have installed. Install them into a supported agent's config directory:

raptor install-skills --agent claude    # also: gemini, codex
raptor install-skills --upgrade         # refresh previously installed skills

Skills install globally by default. Pass --path <dir> to install them at the project level instead.

These are separate from your organisation's skill catalogue, which lives on the control plane and is installed by praxis login. Most people want both: see Build with an AI agent.