Facets CLI

This documentation provides a quick reference guide for using the facetsctl CLI tool. It's an easy-to-use alternative to Facets APIs that allows users to push new docker artifacts to the Facets Control Plane and refresh Kubernetes credentials for the user in a specified environment.

NPM Page

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

Commands

facetsctl provides the following commands for users.

`facetsctl help`

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

ARGUMENTS
COMMAND: Command to show help for.

FLAGS

Flag	Required	What does it do?
`-n, --nested-commands`	No	Defines if all nested commands should be included in the output.

`facetsctl login`

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

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

FLAGS

Flag	Required	What does it do?
`-c, --cp-url` = `<value>`	Yes	Defines the URL of the Control plane
`-t, --access-token` = `<value>`	Yes	Defines the personal token generated for the user
`-u, --username` = `<value>`	Yes	Defines the username of the user

`facetsctl push`

This command will let users push new docker artifacts to the Facets Control Plane.

$ facetsctl push -i <value> -a <value> --registration-type CLUSTER|RELEASE_STREAM --registration-value  
    <value> -e <value> [-d <value>] [--artifactory <value>]

FLAGS

Flag	Required	What does it do?
`-a, --artifact-name` = `<value>`	Yes	Defines the name of the artifact as mentioned in blueprint
`-d, --description` = `<value>`	No	Defines the description of the build, if any
`-e, --external-id` = `<value>`	Yes	Defines the external identifier for the artifact
`-i, --docker-image` = `<value>`	Yes	Defines the image location. Used as <IMAGE:TAG>.
`--artifactory` = `<value>`	No	Defines the artifactory where the image will be pushed.
`--registration-type` = `<option>`	Yes	Defines the mode of registration. Used as <options: CLUSTER\|RELEASE_STREAM>.
`--registration-value` = `<value>`	Yes	Defines the value for release stream or cluster id, based on mode of registration.

`facetsctl refresh`

This command will refresh the Kubernetes credentials for the user in the specified environment.

facetsctl refresh --cluster-id <value> 
#or 
facetsctl refresh --blueprint-name <value> --cluster-name <value>

FLAGS

Flag	Required?	What does it do?
`--cluster-id`	Yes	Defines the unique id for the environment.
`--blueprint-name`	Yes	Defines the unique name of the defined blueprint.
`--cluster-name`	Yes	Defines the name of the environment in the defined blueprint.

Facets CLI version v1.0.5

For Mac Os

Type	Architecture	Download link
Gzip	64-bit	facetsctl-darwin-x64.tar.gz
XZ	64-bit	facetsctl-darwin-x64.tar.xz
Gzip	ARM64	facetscti-darwin-arm64.tar.gz
XZ	ARM64	facetsctI-darwin-arm64.tar.xz

For Linux

Type	Architecture	Download link
Gzip	64-bit	facetsctl-linux-x64.tar.gz
XZ	64-bit	facetsctI-linux-×64.tar.xz
Gzip	ARM	facetsctl-linux-arm.tar.gz
XZ	ARM	facetscti-linux-arm.tar.xz

For Windows

Type	Architecture	Download link
Gzip	64-bit	facetsctl-win32-x64.tar.gz
XZ	64-bit	facetsctl-win32-x64.tar.xz
Gzip	32-bit	facetsctI-win32-x86.tar.gz
XZ	32-bit	facetsctI-win32-x86.tar.xz