https://github.com/python-ellar/ellar-cli

Ellar CLI Tooling
https://github.com/python-ellar/ellar-cli

cli command-line ellar python

Last synced: 4 months ago
JSON representation

Ellar CLI Tooling

• Host: GitHub
• URL: https://github.com/python-ellar/ellar-cli
• Owner: python-ellar
• License: mit
• Created: 2022-11-05T22:25:53.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-10-04T06:59:39.000Z (4 months ago)
• Last Synced: 2025-10-07T13:44:30.599Z (4 months ago)
• Topics: cli, command-line, ellar, python
• Language: Python
• Homepage: https://python-ellar.github.io/ellar/cli/introduction/
• Size: 2.08 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



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


![Test](https://github.com/python-ellar/ellar-cli/actions/workflows/test_full.yml/badge.svg)

![Coverage](https://img.shields.io/codecov/c/github/python-ellar/ellar-cli)

[![PyPI version](https://badge.fury.io/py/ellar-cli.svg)](https://badge.fury.io/py/ellar-cli)

[![PyPI version](https://img.shields.io/pypi/v/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)

[![PyPI version](https://img.shields.io/pypi/pyversions/ellar-cli.svg)](https://pypi.python.org/pypi/ellar-cli)

# 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](https://click.palletsprojects.com/en/8.1.x/)

## Installation

if you have [ellar](https://github.com/python-ellar/ellar) install ready

```

pip install ellar-cli

```

## Usage

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

```shell

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](https://python-ellar.github.io/ellar/cli/introduction/)