Skip to main content

​
Introduction

The django_superapp CLI is a command-line tool for bootstrapping and managing Django SuperApp projects and applications. It provides commands to create new projects, add apps, and synchronize templates with remote repositories.

​
Installation

The CLI is installed automatically when you install the django-superapp package: 
pip install django-superapp
After installation, the django_superapp command will be available in your terminal.

​
Prerequisites

Some commands require additional tools to be installed:
  • GitHub CLI (gh): Required for push-template command 
    brew install gh
  • rsync: Required for push-template command (usually pre-installed on Unix systems)

​
Available Commands

The django_superapp CLI provides the following commands:

bootstrap-project

Create a new SuperApp project from a template repository

bootstrap-app

Create a new app inside an existing SuperApp project

pull-template

Update local project with changes from the remote template

push-template

Push local changes back to the remote template repository

​
Command Structure

All commands follow the standard CLI pattern: 
django_superapp [COMMAND] [OPTIONS] [ARGUMENTS]

​
Getting Help

To see all available commands: 
django_superapp --help
To get help for a specific command: 
django_superapp [COMMAND] --help

​
Common Workflows

​
Creating a New Project

  1. Bootstrap a new project: 
    django_superapp bootstrap-project my-project
  2. Navigate to the project: 
    cd my-project
  3. Add apps as needed: 
    cd superapp/apps
django_superapp bootstrap-app my-app

​
Updating from Template

Keep your project synchronized with template updates: 
django_superapp pull-template .

​
Contributing Changes Back

If you’ve made improvements you want to share: 
django_superapp push-template .

​
Next Steps

Bootstrap Project

Learn how to create a new SuperApp project

Bootstrap App

Learn how to add apps to your project

Build docs developers (and LLMs) love

Get started for freeTalk to us