CLI Reference

This page shows the help screens for the fractalctl command and its subcommands.

fractalctl

usage: fractalctl [-h] {start,openapi,set-db,init-db-data,update-db-data} ...

fractal-server commands

options:
  -h, --help            show this help message and exit

Commands:
  {start,openapi,set-db,init-db-data,update-db-data}

fractalctl start

usage: fractalctl start [-h] [--host HOST] [-p PORT] [--reload]

Start the server (with uvicorn)

options:
  -h, --help            show this help message and exit
  --host HOST           bind socket to this host (default: 127.0.0.1)
  -p PORT, --port PORT  bind socket to this port (default: 8000)
  --reload              enable auto-reload

fractalctl openapi

usage: fractalctl openapi [-h] [-f OPENAPI_FILE]

Save the `openapi.json` file

options:
  -h, --help            show this help message and exit
  -f OPENAPI_FILE, --openapi-file OPENAPI_FILE
                        Filename for OpenAPI schema dump

fractalctl set-db

usage: fractalctl set-db [-h]

Initialise/upgrade database schemas.

options:
  -h, --help  show this help message and exit

fractalctl init-db-data

usage: fractalctl init-db-data [-h] [--resource RESOURCE] [--profile PROFILE]
                               [--admin-email ADMIN_EMAIL]
                               [--admin-pwd ADMIN_PWD]
                               [--admin-project-dir ADMIN_PROJECT_DIR]

Populate database with initial data.

options:
  -h, --help            show this help message and exit
  --resource RESOURCE   Either `default` or path to the JSON file of the first
                        resource.
  --profile PROFILE     Either `default` or path to the JSON file of the first
                        profile.
  --admin-email ADMIN_EMAIL
                        Email of the first admin user.
  --admin-pwd ADMIN_PWD
                        Password for the first admin user.
  --admin-project-dir ADMIN_PROJECT_DIR
                        Project_dir for the first admin user.

fractalctl update-db-data

usage: fractalctl update-db-data [-h]

Apply data-migration script to an existing database.

options:
  -h, --help  show this help message and exit