howto-cli 0.0.4

Multi-scenarios CLI tool for tutorials, guides or stories.

howto

Howto is a useful tool to design and play tutorials, guides or even stories in your shell.

Install

pip3 install howto-cli

Usage

usage: howto [-h] [--version] [-v] file

Multi-scenarios CLI tool for tutorials, guides or stories.

positional arguments:
  file           JSON scenario file path

optional arguments:
  -h, --help     show this help message and exit
  --version      show program's version number and exit
  -v, --verbose  print debug operation

Creating a scenario

The easiest way of creating your scenario is to get inspired by examples.

Most of prompts are based on the PyInquirer library. Howto adds the JSON-config feature and several addons such as markdown support.

TODOs

• Make it possible to save howtos to run them without specifying a scenario file path

  Let's say you have a cook-a-cake.json scenario file. Let's save it.

  howto --load ./cook-a-cake.json
  

  Now, anywhere on your computer, you can run :

  howto cook-a-cake
  # instead of `howto ./cook-a-cake.json`