A CLI-based word guessing game inspired by Wordle — played entirely in your terminal, written in Python, no dependencies required.
Guess a secret 6-letter word in up to 6 attempts. After each guess, every letter is colour-coded:
| Colour | Meaning |
|---|---|
| 🟩 Green | Correct letter, correct position |
| 🟨 Yellow | Letter is in the word, wrong position |
| ⬛ Gray | Letter is not in the word |
You also start with 6 hints — type hint <1-6> to reveal any letter position for free (costs one hint).
# Clone the repo
git clone git@github.com:vyaas/guessIt.git
cd guessIt
# Run the game (Python 3.6+ required, no pip installs needed)
python guessit.py| Input | Action |
|---|---|
CASTLE |
Guess the word (6 letters, case-insensitive) |
hint 3 or h 3 |
Reveal the letter at position 3 |
help or ? |
Show in-game instructions |
quit or q |
Exit the game |
Attempt 2/6 💡 Hints: 5
S T U P I D ← U is yellow (in word, wrong spot)
[ ][ ][ ][ ][ ][ ]
Enter your guess (or 'hint <1-6>'): _
guessIt/
├── guessit.py # Main game — single self-contained file
├── words.txt # Word list (20 six-letter words, easy to extend)
├── README.md # This file
└── plans/ # Design docs & architecture (for contributors)
├── guessit-design.md
├── guessit-diagrams.md
└── implementation-guide.md
The design is fully documented before a single line of game code is written — read these first:
plans/guessit-design.md— Game rules, data structures, module breakdown, UX flows.plans/guessit-diagrams.md— Mermaid diagrams: architecture, game flow, state machine, hint sequence.plans/implementation-guide.md— Phase-by-phase checklist, pseudocode, test cases, code style guidelines.
- Python 3.6+, standard library only (no third-party packages).
- CLI first — no GUI, no web server. Keep it terminal-native to avoid debugging overhead.
- Everything lives in two files:
guessit.py+words.txt. Easy to share, easy to run. - Follow PEP 8 and add docstrings to every function.
- The implementation checklist in
plans/implementation-guide.mdmaps out all phases — pick one up and go.
git clone git@github.com:vyaas/guessIt.git
cd guessIt
# Read plans/implementation-guide.md, pick a phase, open guessit.py, start coding.No virtual environment, no pip install, no build step. Just Python.
- Python 3.6 or newer
- A terminal that supports ANSI escape codes (Linux, macOS, Windows Terminal, iTerm2, etc.)
MIT