Skip to main content

Requirements

  • Python 3.13+
  • A running Celery broker
  • One or more Celery workers (with events enabled)

Demo project

The demo project is a local, source-based stack with seeded test data. Use it when you want to run Celery Root from source and explore the UI without wiring up your own workers. It is separate from the packaged install, which uses a prebuilt wheel. See the demo project guide for setup steps.

1. Point Celery Root at your app

Set your worker import paths (comma-separated):
export CELERY_ROOT_WORKERS="your_app.celery:app,another_app.celery:app"
You can also pass app import paths to the CLI with -A.

2. Start Celery Root

Standalone CLI:
celery_root -A your_app.celery:app
Or use the Celery subcommand:
celery -A your_app.celery:app celery_root
By default the UI binds to 127.0.0.1:8000.

3. Open the UI

Open http://127.0.0.1:8000 to see workers, tasks, and queues.

Common options

Override the UI host/port and debug mode:
celery_root -A your_app.celery:app --host 0.0.0.0 --port 8000 --no-debug
Configure storage, logging, metrics, and MCP in the Configuration guide.