Skip to main content

SkillFlaw CLI

The SkillFlaw command line interface is the main interface for running the application from a Python environment.

CLI entry points

You can invoke the CLI in either of these ways:


_10
uv run skillflaw --help

or:


_10
python -m skillflaw --help

The project Makefile wraps common workflows with commands such as make run_cli, make run_clic, make backend, and make backend_start.

Available commands

The current CLI help exposes these top-level commands:

  • run: start SkillFlaw
  • superuser: create a superuser
  • copy-db: copy the database files to the current directory
  • migration: run or test schema migrations
  • api-key: report that unauthenticated CLI API key creation is no longer supported
  • lfx: SkillFlaw Executor commands

Start SkillFlaw

The most common command is:


_10
uv run skillflaw run

If you are working from a source checkout, these Makefile wrappers are usually more convenient:


_10
make run_cli
_10
make run_clic

Use make run_clic when you need a fresh frontend rebuild.

Common run options

The current python -m skillflaw run --help output documents these key options:

OptionDescription
--hostHost to bind the server to
--portPort to listen on
--workersNumber of worker processes
--worker-timeoutWorker timeout in seconds
--env-filePath to the .env file
--frontend-pathPath to built frontend assets
--components-pathPath to custom components
--log-levelLogging level
--log-fileLog file path
--cacheCache backend type
--dev / --no-devEnable development mode
--open-browser / --no-open-browserControl browser auto-open
--backend-only / --no-backend-onlyRun backend without frontend
--auto-saving / --no-auto-savingToggle auto-save
--auto-saving-intervalAuto-save debounce interval
--max-file-size-uploadMaximum upload size in MB
--ssl-cert-file-pathSSL certificate path
--ssl-key-file-pathSSL key path

Example:


_10
uv run skillflaw run --env-file .env --host 0.0.0.0 --port 7860 --no-open-browser

Universal options

All top-level CLI commands support:

  • --version / -v
  • --install-completion
  • --show-completion
  • --help

Other important subcommands

skillflaw superuser

Use this command to create a superuser from the terminal when CLI superuser creation is enabled.


_10
uv run skillflaw superuser --username admin --password 'your-password'

This command is governed by SKILLFLAW_ENABLE_SUPERUSER_CLI.

skillflaw migration

Use this command to inspect or apply schema migrations:


_10
uv run skillflaw migration
_10
uv run skillflaw migration --fix

Run the preview form first, review the output, and only then apply --fix.

skillflaw api-key

This command is retained only to report that unauthenticated CLI API key creation is no longer supported. Create API keys from the authenticated product UI instead of relying on the CLI for key generation.