# cli-guide.js

**Repository Path**: mirrors_twitter-archive/cli-guide.js

## Basic Information

- **Project Name**: cli-guide.js
- **Description**: CLI Guide JQuery Plugin
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-03
- **Last Updated**: 2026-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CLI Guide jQuery Plugin v0.1.4

[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/twitter/cli-guide.js/master/LICENSE)

> A Javascript library for creating interactive command line tutorials that run in your web browser.

Dependencies
-----------------

* [jQuery](https://jquery.com/download/)
* [Prism](http://prismjs.com/download.html)

Demos
-----

* [Apache Aurora](http://twitter.github.io/cli-guide.js/tutorials/aurora.html)
* [CLI Guide](http://twitter.github.io/cli-guide.js/tutorials/cliguide.html)


Documentation
-------------

#### Example


      $('#stepsdiv').cli_guide({
        nameOfTheProject: 'Apache Aurora',
        stepsFile: 'templates/apache_aurora.json',
        skipsteps: '1,2',
        commandStepsFile: 'templates/apache_aurora_commands.json',
        commandValidation: 'templates/apache_aurora_commands_validations.json',
        preloadfile: 'templates/apache_aurora_files.json'
      });

Build
------

- Install node modules

      $ npm install

- For generate files

      $ npm start

- For development

      $ npm run dev

Author
-------
-   Willy Aguirre https://twitter.com/willrre


License
-------

Copyright 2016 Twitter, Inc.

Licensed under the MIT License