# apache-superset-extensions-cli [](https://badge.fury.io/py/apache-superset-extensions-cli) [](https://opensource.org/licenses/Apache-2.0) [](https://www.python.org/downloads/) Official command-line interface for building, bundling, and managing Apache Superset extensions. This CLI tool provides developers with everything needed to create, develop, and package extensions for the Superset ecosystem. ## 🚀 Features - **Extension Scaffolding** - Generate initial folder structure and scaffold new extension projects - **Validation** - Validate extension structure and configuration before building - **Development Server** - Automatically rebuild extensions as files change during development - **Build System** - Build extension assets for production deployment - **Bundle Packaging** - Package extensions into distributable .supx files ## 📦 Installation ```bash pip install apache-superset-extensions-cli ``` ## 🛠️ Quick Start ### Available Commands ```bash # Scaffold a new extension project (interactive prompts, or pass options directly) superset-extensions init [--publisher ] [--name ] [--display-name ] [--version ] [--license ] [--frontend/--no-frontend] [--backend/--no-backend] # Validate extension structure and configuration superset-extensions validate # Build extension assets for production (runs validate first) superset-extensions build # Package extension into a distributable .supx file (runs build first) superset-extensions bundle [--output/-o ] # Automatically rebuild extension as files change during development superset-extensions dev ``` ## 📋 Extension Structure The CLI scaffolds extensions with the following structure: ``` {publisher}.{name}/ # e.g., my-org.dashboard-widgets/ ├── extension.json # Extension configuration and metadata ├── .gitignore ├── frontend/ # Optional frontend code │ ├── src/ │ │ └── index.tsx # Frontend entry point │ ├── package.json │ ├── webpack.config.js │ └── tsconfig.json └── backend/ # Optional backend code ├── src/ │ └── {publisher}/ # e.g., my_org/ │ └── {name}/ # e.g., dashboard_widgets/ │ └── entrypoint.py └── pyproject.toml ``` ## 📄 License Licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/apache/superset/blob/master/LICENSE.txt) for details. ## 🔗 Links - [Community](https://superset.apache.org/community/) - [GitHub Repository](https://github.com/apache/superset) - [Extensions Documentation](https://superset.apache.org/developer-docs/extensions/overview)