GitQuest

A friendly, game-like CLI for everyday version control checkpoints.

---

GitQuest turns common Git workflows into a calm, guided experience. Think quick save points, safe discards, and an interactive history browser — all wrapped in a chill UX.

💡 Why GitQuest?

GitQuest turns version control into a calm, intentional habit.
Instead of memorizing Git commands, you focus on flow — saving progress like checkpoints, syncing safely, and staying mindful of your creative rhythm.

📥 Installation and Quickstart

Requires Node.js v18 or higher.

- Install globally from npm:

npm install -g @a4ayush/gitquest

Then, run gq in any git repository to launch the interactive experience:

gq

- For local development and testing:

# from the project root
npm install
npm link
# now you can use `gq` locally
gq

💥 One-Shot Commands

All examples use the gq shorthand alias, but using the full gitquest command works just as well. They are completely interchangeable.

gq save

Commits all changes, pushes to origin, and shows your save stats and streaks.

gq save "Your commit message"

gq discard

Resets the working tree and cleans untracked files. When not forced, it prompts for confirmation.

gq discard
gq discard --force

gq sync

Pulls remote changes and reports whether you’re up to date.

gq sync

gq help

Prints the usage and basic help message.

gq help

⚠️ Safety notes

⚠️ Warning: Commands like gq discard --force or branch resets in history are irreversible. Always make sure you’ve committed any work you want to keep.

• gq discard --force is a destructive and irreversible action. Use it with caution.
• The reset action in the history browser will overwrite the remote history. It requires explicit confirmation and should only be used when you fully understand the consequences.

🐞 Reporting bugs

If you encounter any issues, please open an issue on GitHub: https://github.com/a4ayush/gitquest/issues

When reporting, please include:

• Your Node.js and npm versions.
• The minimal steps to reproduce the bug.
• The state of your repository if relevant (e.g., clean, dirty, behind remote).

⚖️ License and Credits

• License: MIT © Ayush Saxena (See the LICENSE file for details)
• Author: Ayush Saxena
• Contributors: Orion (AI collaborator)
• Powered by: @clack/prompts, chalk, and simple-git.

---

“May your branches stay clean and your streaks stay alive.”