https://github.com/mayfield/shellish

Framework for creating shell-ish command line programs.
https://github.com/mayfield/shellish

cli python

Last synced: 4 months ago
JSON representation

Framework for creating shell-ish command line programs.

• Host: GitHub
• URL: https://github.com/mayfield/shellish
• Owner: mayfield
• License: mit
• Created: 2015-08-25T06:33:54.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2025-11-06T06:31:13.000Z (8 months ago)
• Last Synced: 2026-01-03T04:19:54.016Z (6 months ago)
• Topics: cli, python
• Language: Python
• Size: 345 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
shellish

===========

_*Command-line/shell mashup framework*_

[![Maturity](https://img.shields.io/pypi/status/shellish.svg)](https://pypi.python.org/pypi/shellish)

[![License](https://img.shields.io/pypi/l/shellish.svg)](https://pypi.python.org/pypi/shellish)

[![Change Log](https://img.shields.io/badge/change-log-blue.svg)](https://github.com/mayfield/shellish/blob/master/CHANGELOG.md)

[![Build Status](https://semaphoreci.com/api/v1/mayfield/shellish/branches/master/shields_badge.svg)](https://semaphoreci.com/mayfield/shellish)

[![Version](https://img.shields.io/pypi/v/shellish.svg)](https://pypi.python.org/pypi/shellish)

About

--------

This module combines the Python standard library modules argparse and cmd

to provide a unified way to make cli programs that can also be interactive

(when invoked in "shell" mode).

The main benefit to using this package is streamlined command hierarchy when

you want to have rich set of subcommands along with a pretty powerful tab

completion layer that parses argparse arguments automagically.

Requirements

--------

Posix-like platform

Installation

--------

**PyPi Stable Release**

```

pip3 install shellish

```

    

**Development Release**

```

python3 ./setup.py build

python3 ./setup.py install

```

*or*

```

python3 ./setup.py develop

```

Compatibility

--------

* Python 3.5+

Examples

--------

* [Hello World](examples/hello_world.py)

* [Decorator](examples/decorator.py)

* [Nesting (Subcommands)](examples/simple_nesting.py)

* [Alternate Styles](examples/skin_a_cat.py)

* [Tab Completion](examples/tabcompletion.py)

[All Examples](examples/)