Code Monkey home page Code Monkey logo

demo-helper's Introduction

A script for pretty-ish cli demos

This is a bash script for creating/automating cli-based demos.

To see what it can do, run it for a quick demo:

$ ./demo-helpers.sh
...

Usage

Include the demo-helpers.sh script in your demo script, then make use of the provided functions.

#! /bin/bash

. demo-helpers.sh

cmd echo "This runs a command"

Adding demos to documentation

Turn your scripted demo into an animated GIF w/ asciinema and asciicast2gif:

$ asciinema rec -c ./demo-helpers.sh demo.cast
asciinema: recording asciicast to demo.cast
asciinema: exit opened program when you're done
...
asciinema: recording finished
asciinema: asciicast saved to demo.cast

$ docker run --rm -v $PWD:/data:z asciinema/asciicast2gif -S 1 demo.cast demo.gif
==> Loading demo.cast...
==> Spawning PhantomJS renderer...
==> Generating frame screenshots...
==> Combining 279 screenshots into GIF file...
==> Done.

Result:
demo

demo-helper's People

Contributors

johnstrunk avatar

Stargazers

avatar

Watchers

avatar avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.