quizam v1.2.1

Quizam

Like Shazam for CLI quizzes but without the wizardry

Install

npm i -g quizam

Usage

$ quizam help

    Quizam

    Quiz yourself using yaml files!

    Command                 Exec
    ---------------         ---------------

    quizam help             Display help
    quizam init [file]      Initialise quizam.yaml file at base or designated [file] path (must include quizam.yaml)
    quizam run [file]       Generate doc files or pass [file] as file/to/path to generate doc for specific file

    Flags                   Function
    ---------------         ---------------
    -i                      Ignore folders (paths as folders/files divided by commas)
    -v                      Verbose errors

    Examples
    ---

    $ quizam run
    > # recursively searches for *quizam.yaml files
    > # runs quiz

    $ quizam run -i=build, dist
    > # recursively searches for *quizam.yaml files ignoring build and dist dir
    > # runs quiz

    $ quizam run path/to/quizam.yaml
    > # runs path/to/quizam.yaml quiz

    $ quizam init
    > # create quizam.yaml in current directory

    $ quizam init path/to/custom-quizam.yaml
    > # create quiz at path/to/custom-quizam.yaml

    Built by Dennis O'Keeffe

    Twitter: @dendribbles
    Github: https://github.com/okeeffed

Basic Example

quizam init to initialise a quizam.yaml base file.

name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
  - type: select
    question: What is the best CLI app?
    choices:
      - Quiz Gon Gin
      - Quizam
      - Quizalicious
      - Quiztacular
    answer: Quizam
  - type: select
    question: Where is Melbourne?
    choices:
      - USA
      - England
      - Australia
      - New Calidonia
    answer: Australia
  - type: confirm
    question: Is Quizam your favourite?
    answer: true
  - type: multi
    question: What equals 17?
    choices:
      - 10 + 7
      - 20 - 4
      - 1 + 17
      - 5 + 5 + 5 + 2
    answer:
      - 10 + 7
      - 5 + 5 + 5 + 2
  - type: input
    question: Spell "quizam"?
    answer: quizam

quizam run to run the quiz CLI.

Types

Input

Compares user input to answer.

name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
  - type: input
    question: Spell "quizam"?
    answer: quizam

Select

Gives list to select single option.

name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
  - type: select
    question: What is the best CLI app?
    choices:
      - Quiz Gon Gin
      - Quizam
      - Quizalicious
      - Quiztacular
    answer: Quizam

Multiselect

Gives list to select multiple options.

name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
  - type: multi
    question: What equals 17?
    choices:
      - 10 + 7
      - 20 - 4
      - 1 + 17
      - 5 + 5 + 5 + 2
    answer:
      - 10 + 7
      - 5 + 5 + 5 + 2

Confirm

Y/n response to a question.

name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
  - type: confirm
    question: Is Quizam your favourite?
    answer: true

Dependencies

nodeca/js-yaml

License

MIT © Dennis O'Keeffe