Skip to content

facet CLI

Generated from src/cli/commands.cr by make gen-docs-cli. Do not edit this file by hand.

Use this page to find a facet command and check how it handles options.

One facet call can run several commands in a row: facet db_reset --yes seed:dev. A command that consumes its own options reads every following token as its option. Such a command must be last in a chain. Every other command takes only its dash options, and the chain continues after them. server is the default command and starts the HTTP server.

Command Purpose Options
accounts:create Create an account and print a one-time password (run standalone to pass email and options) consumes its own options
accounts:list List accounts (id, email, display name, status, roles) —
artifacts:prune Soft-delete (or –hard delete) artifacts with no live owner or recent reference consumes its own options
artifacts:reconcile Delete orphaned objects from the artifact store (run standalone to pass options) consumes its own options
artifacts:revoke Revoke every signed URL for an artifact (run standalone to pass the artifact id) consumes its own options
auth:mode Pin the authentication mode on the SystemSettings document (run standalone: facet auth:mode {hybrid|oidc_only}) consumes its own options
db_reset Drop, recreate and migrate the database (asks to confirm; –yes skips) —
doctype:migrate-retry Re-run lazy migration for documents blocked by a meta.migration_error marker consumes its own options
doctype:reproject Re-project a doctype’s search/links/display_name columns for every live document consumes its own options
domain:export Export a domain definition to a directory or .tar.gz (run standalone to pass options) consumes its own options
domain:import Import a domain definition from a directory or .tar.gz (run standalone to pass options) consumes its own options
index:retry Retry failed index creations (run standalone to pass options) consumes its own options
migrate Run database migrations —
migrate:down Revert applied migrations (run standalone to pass a target) consumes its own options
roles:add Assign a role to an account (run standalone to pass account and role) consumes its own options
roles:list List roles (id, name) —
seed:admin Create the first admin with a generated one-time password (run standalone to pass the email) consumes its own options
seed:core Seed core doctypes and the currency registry (idempotent, non-destructive) —
seed:dev Seed the dev admin (admin@example.tld / admin, refused when APP_ENV=production) —
server Start the HTTP server (default; long-running, must be last in a chain) —