Skip to content

python-ellar/ellar-cli

Repository files navigation

Ellar Logo

Ellar CLI Tool for Scaffolding Ellar Projects and Modules and also running Ellar Commands

Test Coverage PyPI version PyPI version PyPI version

Introduction

Ellar-CLI is an abstracted tool for the Ellar web framework that helps in the standard project scaffolding and other application commands.

Ellar CLI is built on Click

Installation

if you have ellar install ready

pip install ellar-cli

Usage

To verify ellar-cli is working, run the command below

ellar --help

The above command should output this:

Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...

Options:
  -p, --project TEXT              Run Specific Command on a specific project
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  create-module   - Scaffolds Ellar Application Module -
  create-project  - Scaffolds Ellar Application -
  new             - Runs a complete Ellar project scaffold and creates...
  runserver       - Starts Uvicorn Server -
  say-hi

Full Documentation: Here