README.md

ShellTools

Quickly build command line interface to operate a remote target that uses Unpadded over serial

Installation

As a user

Add this repository as a submodule of your project.

git submodule add https://github.com/Club-INTech/ShellTools
git submodule update

Install the Python dependencies from requirements.txt.

pip3 install -r ShellTools/requirements.txt

Unpadded will require ccache to run. Install it from your packet manager (e.g. Aptitude).

sudo apt install ccache

If you want a taste of the features provided by the shell package, you can run the demo shell.

python3 ShellTools/demo.py

As a developper

If you want to contribute, please install the necessary development tools.

sudo apt install ccache
./configure

Do not forget to test your installation afterwards.

./check

• Create an asynchronous command line interface with the Shell class

  • Building a basic shell

    • Synchronous commands

    • Asynchronous commands

    • Support for docstrings

  • Capturing the keyboard input

  • Display banners under the prompt

  • shell API

    • Shell

      • Shell.banner()

      • Shell.create_task()

      • Shell.default()

      • Shell.do_EOF()

      • Shell.is_running

      • Shell.log()

      • Shell.log_error()

      • Shell.log_help()

      • Shell.log_status()

      • Shell.prompt

      • Shell.run()

      • Shell.use_rawinput

    • ShellError

  • command API

    • argument()

    • command()

  • banner API

    • BarSpinner

    • ProgressBar

      • ProgressBar.progress

    • TwoWayBar

      • TwoWayBar.progress

• Handle a communication with a target through a serial line

  • Generating the extension module from the keyring

  • Setting up the connection to the target

  • Sending an action request to the target

  • remote API

    • Remote

      • Remote.new_request()