0.1.0 • Published 3 years ago

git-quest v0.1.0

Weekly downloads
-
License
-
Repository
github
Last release
3 years ago

git-quest

⚠ WARNING: This project isn't active The ways to add new quests isn't robust and scalable enough. Check out Githug as an alternative with more levels.

Run npm install git-quest to get your quest and visit the website for more details

Zero setup git practice

Tired of fighting with git everyday? Git-Quest allows you to practice with real world use-cases. No need to setup a repository, the command-line tool can do it for you. It comes along with a website full of quests.

Features | Installation | Usage

Website

  • Automatic environment setup
  • Many quests for any level
  • Detailed step by step help

Give it a try, look at the first quest and complete it

How can I help?

  1. Create new quests
  2. Open issues on broken quests
  3. Fix open issues by sending PRs

Installation

With npm installed, run

$ npm install git-quest

Usage

$ git-quest  
Usage: git-quest [options] [command]

Options:
  -V, --version       output the version number
  -h, --help          output usage information

Commands:
  list                List available quests
  init <quest> [dir]  Begin a new quest
  read [options]      Read current quest instructions
  help [options]      Show current quest help   

init <quest> [dir]

Creates the directory containing the given quest sources. Caution: resets any existing directory for this quest.

  • quest - Quest id (see list).
  • dir - Location where the quest directory should be initialized.
    Defaults to the current directory.

list

Display the list of available quests with their id (used in init).
Also available on the website.

read [options]

Opens the current quest instructions in the browser based on current directory.

Options:

  • -q, --quest - Quest id

help [options]

Opens the current quest help in the browser based on current directory.

Options:

  • -q, --quest - Quest id