https://github.com/okeeffed/quizam
Quizam! Like Shazam, but more wizardry. A CLI tool for quickly running YAML quizzes.
https://github.com/okeeffed/quizam
cli cli-app command-line interactive prompts quiz yaml
Last synced: 5 months ago
JSON representation
Quizam! Like Shazam, but more wizardry. A CLI tool for quickly running YAML quizzes.
- Host: GitHub
- URL: https://github.com/okeeffed/quizam
- Owner: okeeffed
- Created: 2019-02-22T09:26:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-25T09:24:22.000Z (over 7 years ago)
- Last Synced: 2025-09-07T15:53:18.875Z (10 months ago)
- Topics: cli, cli-app, command-line, interactive, prompts, quiz, yaml
- Language: JavaScript
- Homepage:
- Size: 166 KB
- Stars: 4
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quizam
> Like Shazam for CLI quizzes but without the wizardry
## Install
```sh
npm i -g quizam
```
## Usage
```sh
$ 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.
```yaml
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.
```yaml
name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
- type: input
question: Spell "quizam"?
answer: quizam
```
### Select
Gives list to select single option.
```yaml
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.
```yaml
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.
```yaml
name: Hello Quizam!
author: Dennis O'Keeffe
quiz:
- type: confirm
question: Is Quizam your favourite?
answer: true
```
## Dependencies
[nodeca/js-yaml](https://github.com/nodeca/js-yaml)
## License
MIT © [Dennis O'Keeffe](https://dennisokeeffe.com)