Skip to content

cl0wng1rl/kwz

Repository files navigation

kwz

GitHub top language npm npm bundle size npm dependencies

A terminal-based quiz game!

InstallationUsing kwzLicense


Installation

To install kwz, run the following command:

npm install --global kwz

Using kwz

You can play a quiz using kwz by simply running:

kwz

You can set the number of questions, the type of answers, the difficulty of the questions and the category.

kwz --number 5 --difficulty hard --category 9 --true-or-false

Number of Questions

The number of questions can be set using the --number or -n flag. This flag requires an integer representing the numbers of questions that you'll be asked. The default value is 10.

Question Type

The question type can be set to true-or-false using the --trueOrFalse or -t flag. Without this flag, questions will be multiple choice.

Difficulty

The difficulty can be set using the --difficulty or -d flag. This flag requires either "easy", "medium" or "hard". By default, questions of all difficulty will be asked.

Category

The category can be set using the --category or -c flag. This flag requires an integer representing the category code. These can be found using the categories subcommand. By default, questions in all categories will be asked.

The categories Command

The categories subcommand returns a list of categories followed by their category code. The categories command looks like:

kwz categories

Help

To get help using kwz, run:

kwz --help

License

MIT