Skip to content

Facet app CLI

Generated from packages/cli by make gen-docs-npm-cli. Do not edit this file by hand.

The @facetapp/cli npm package deploys a static build folder as a new revision of a Facet app. It lists and activates revisions and manages sign-in against a Facet instance. No install step is required: run the commands through pnpx @facetapp/cli. The package needs Node 20 or newer. Commands read facet.config.json from the working directory; init writes it.

Command Options Purpose
init --yes, --app <slug>, --build <dir>, --server <url> Write a facet.config.json file for this project.
login --target <name> Sign in to a Facet instance and store the session.
logout --target <name> Remove the stored session for a Facet instance.
whoami --target <name> Show the stored account, role, instance, and active revision.
deploy --target <name>, --note <text>, --no-activate Upload the build folder as a new deployment of the app.
releases --target <name> List the deployments of the app, newest first.
rollback <revision> --target <name> Set an older revision as the active deployment.
help [command] — display help for command

The blocks below are the captured help texts of the package.

Usage: facet-cli [options] [command]
Command-line interface for Facet.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
init [options] Write a facet.config.json file for this
project.
login [options] Sign in to a Facet instance and store the
session.
logout [options] Remove the stored session for a Facet instance.
whoami [options] Show the stored account, role, instance, and
active revision.
deploy [options] Upload the build folder as a new deployment of
the app.
releases [options] List the deployments of the app, newest first.
rollback [options] <revision> Set an older revision as the active deployment.
help [command] display help for command
Usage: facet-cli init [options]
Write a facet.config.json file for this project.
Options:
--yes Create the app without asking for confirmation.
--app <slug> App slug to write to the config.
--build <dir> Build folder to upload (default: dist).
--server <url> Facet instance URL to add as the default target.
-h, --help display help for command
Usage: facet-cli login [options]
Sign in to a Facet instance and store the session.
Options:
--target <name> Named target from facet.config.json to sign in to.
-h, --help display help for command
Usage: facet-cli logout [options]
Remove the stored session for a Facet instance.
Options:
--target <name> Named target from facet.config.json to sign out of.
-h, --help display help for command
Usage: facet-cli whoami [options]
Show the stored account, role, instance, and active revision.
Options:
--target <name> Named target from facet.config.json to ask.
-h, --help display help for command
Usage: facet-cli deploy [options]
Upload the build folder as a new deployment of the app.
Options:
--target <name> Named target from facet.config.json to deploy to.
--note <text> Short note to attach to the new deployment.
--no-activate Keep the new deployment inactive after the upload.
-h, --help display help for command
Usage: facet-cli releases [options]
List the deployments of the app, newest first.
Options:
--target <name> Named target from facet.config.json to ask.
-h, --help display help for command
Usage: facet-cli rollback [options] <revision>
Set an older revision as the active deployment.
Options:
--target <name> Named target from facet.config.json to ask.
-h, --help display help for command