clitutor
Version:
Interactive CLI learning tool for beginners
129 lines (82 loc) • 3.49 kB
Markdown
# 🚀 clitutor - Become friends with your terminal!
**Stop being afraid of the command line!** 🎯
clitutor is your friendly companion that turns the scary black screen into your new superpower. Learn by doing, not by reading boring docs!
## 🎮 Why?
With a increasing number of products choosing to only offer a command line interface (such as ClaudeCom), it's important to learn how to use the command line!
This is a project that I would have loved to have when I started learning the command line.
And I'm open sourcing it to help others learn as well!
## 🎯 Features
- **🗣️ Conversational**: Like having a patient friend teaching you
- **🎨 Visual**: Colors, progress bars, and ASCII art make learning fun
- **🏃 Interactive**: Practice commands safely - we won't let you break anything!
- **📈 Progressive**: Start simple, become a terminal ninja
- **🎯 Practical**: Learn what you'll actually use, skip the boring stuff
## 📦 Pre-requisites
- Node.js
- npm
- git
If you don't have Node.js or npm installed, you can install it from [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
If you don't have git installed, you can install it from [here](https://git-scm.com/downloads).
## ⚡ Quick Start
```bash
npm install -g clitutor
clitutor
```
That's it! No complicated setup. Just start learning! 🎉
## 📚 What You'll Learn
### Chapter 1: Understanding Commands 🧩
_"It's just like texting, but with your computer!"_
- How commands work
- The pattern behind every command
- Stop memorizing, start understanding
### Chapter 2: Terminal Navigation ⌨️
_"Move like a pro without touching your mouse!"_
- Keyboard shortcuts that save you time
- Edit and autocomplete commands
- Navigate your terminal like a pro
### Chapter 3: File Navigation 📁
_"Your files, but faster!"_
- Jump around folders
- Create, move, delete files
- Open any file from terminal
### Chapter 4-6: Git Mastery 🔄
_"From 'what's Git?' to 'Git expert' in 3 chapters!"_
- **Chapter 4**: Time travel for your code and files
- **Chapter 5**: Collaborate without conflicts
- **Chapter 6**: Power moves that impress
## 🛠️ Bonus Tools
```bash
clitutor memo # 🎯 Quick command reference
clitutor git # 🔄 Complete Git cheatsheet
```
Call these ones if you forget something while you work, quick access to cheat codes!
### 🌟 Ideas for New Chapters
- Package managers (npm, pip, brew)
- Terminal customization (zsh, bash, etc.)
- Docker basics
- SSH and remote servers
- Shell scripting
### 💡 Join the mission!
Completely open for contributions!
1. **Report bugs**: Something confusing? Let us know!
2. **Suggest improvements**: Make lessons clearer
3. **Add exercises**: Create fun challenges
4. **New chapters**: Teach what you know
5. **Translations**: Help non-English speakers
Check out `claude.md` for our chapter-building philosophy!
## 🎨 Built Using
- **inquirer** - Interactive prompts
- **chalk** - Beautiful colors
- **boxen** - Pretty boxes
- **ora** - Smooth spinners
## 🙋 FAQ
**Q: Will I break my computer?**
A: No! We teach in a safe environment. Break things, learn, repeat!
**Q: Is this for Windows/Mac/Linux?**
A: Yes! Commands are explained for all platforms.
**Q: I'm stuck!**
A: The terminal is your friend and will give hints. Can't solve it? Skip it!
c
---
_Made with ❤️ by [@tomimor](https://github.com/tomimor)_
**Ready? Type `clitutor` and let's go! 🚀**