Skip to content

XCore CLI

The xcore command-line interface (CLI) is a powerful tool designed to manage every aspect of your XCore framework project. From scaffolding new plugins to managing background workers and monitoring system health, the CLI is your primary interface for development and administration.

Key Features

  • Lifecycle Management: Easily initialize projects and manage the lifecycle of your application.
  • Plugin Control: Scaffold, install, update, and manage plugins from the marketplace or local directories.
  • Real-time Monitoring: Integrated dashboard for monitoring resource usage and logs.
  • Background Workers: Manage Celery workers and background tasks with ease.
  • Database Migrations: Integrated support for database migrations and backups.

Getting Started

If you're new to the XCore CLI, we recommend starting with the Getting Started guide.

Command Groups

The CLI is organized into several command groups:

  • Manager: Administration and monitoring.
  • Plugin: Plugin lifecycle and development.
  • Worker: Background task management.
  • Sandbox: Security and isolation settings.
  • Migration: Database schema management.
  • Config: System configuration tools.

Quick Reference

For a complete list of all commands and their options, check out the Full CLI Reference.