Facets CLI

Note: If you are using the older version of facetsctl, refer to the Facets CLI documentation.

This documentation serves as a quick reference guide for using the facetsctlv3 CLI tool. It offers an easy-to-use alternative to Facets APIs, enabling users to push new Docker artifacts to the Facets Control Plane and refresh Kubernetes credentials for a specified environment.

NPM Page

You can view and download the latest facetsctlv3 package from its NPM page.

Commands

Note: Ensure you run the login and artifact init commands before using the push, register, or upload commands.

facetsctlv3 provides the following commands for users:

facetsctl help

This command displays the help for facetsctlv3. You can use it to get information about a specific command by providing the command name as an argument.

 **ARGUMENTS**  $ facetsctl help [COMMAND...] [-n]

ARGUMENTS

COMMAND: Command to display help for.

FLAGS

facetsctl login

This command allows the user to log in to the Facets Control Plane.

$ facetsctl login -u <value> -t <value> -f <value>

$ facetsctl login --username my-user --token my-token --facets-url https://facets-control-plane.example.com

FLAGS

facetsctl artifact init

This command allows you to initialize the artifact information.

$ facetsctl artifact init -p <value> -s <value> -a <value>

$ facetsctl artifact init --project my-project --service my-service --artifactory my-artifactory

FLAGS

facetsctl artifact push

This command allows you to push a Docker image to the configured artifact repository.

$ facetsctl artifact push -d <value>

$ facetsctl artifact push --docker-image my-docker-image:latest

FLAGS

facetsctl artifact register

This command allows you to register a Docker image with the specified type and value.

$ facetsctl artifact register -t GIT_REF|ENVIRONMENT|RELEASE_STREAM -i <value> -v <value> [-r <value>]

$ facetsctl artifact register --type GIT_REF --docker-image my-docker-image:latest --value my-git-ref

FLAGS

facetsctl artifact upload

This command allows you to upload any type of application build file to the Facets Control Plane

$ facetsctl artifact upload -t GIT_REF|ENVIRONMENT|RELEASE_STREAM -f <value> -v <value> [-r <value>]

 $ facetsctl artifact upload --type GIT_REF --file-path file-to-upload --value my-git-ref

FLAGS

facetsctl release sync APPS

This command allows you to sync out-of-sync apps to match their desired state with the deployed state.

$ facetsctl release sync APPS -p <value> -e <value>

ARGUMENTS

APPS: List of app names to sync (comma-separated | example: ... sync app1,app2,app3 -p ...)

FLAGS

facetsctl release wait APPS

This command allows you to wait for the sync status of the specified apps, and trigger sync if --sync is provided

  $ facetsctl release wait APPS -p <value> -e <value> [--sync]

ARGUMENTS

APPS: List of app names to wait for (comma-separated | example: ... sync app1,app2,app3 -p ...)

FLAGS

Facets CLI version v1.1.3

For Mac OS

For Linux

For Windows