quicknote-cli
Version:
A simple command-line tool to take quick notes directly in your terminal — now with persistent storage using JSON!
83 lines (56 loc) • 1.6 kB
Markdown
# 📝 QuickNote CLI
A simple command-line tool to take quick notes directly in your terminal — now with persistent storage using JSON!
> ⚡ Notes are saved to a local `notes.json` file in your current directory.
---
## 🚀 Features
- ✅ Add quick notes from the terminal
- 📂 View saved notes anytime
- 💾 Persistent storage in JSON file
- 🧠 Simple and intuitive command structure
---
## 📦 Installation
Clone the repo and link it globally:
```bash
git clone https://github.com/Briankija/quicknote.git
cd src/
npm install
npm link
💻 Usage
➕ Add a Note
quicknote add "Finish reading Chapter 5"
# or
quicknote a "Fix the login bug"
📋 List All Notes
quicknote list
# or
quicknote ls
📁 How It Works
.✅ When you add a note, it gets saved in notes.json
.📖 When you list notes, it reads from that file
.🗂️ Notes are stored in the current working directory
❓ Help
Get help anytime:
quicknote --help
You’ll see a guide like this:
Welcome to QuickNote CLI
Take temporary notes in your terminal session.
Notes will be saved in notes.json in the current folder.
Usage:
quicknote <command> [options]
Commands:
add <note>, a Add a new note
list, ls List all notes
Examples:
quicknote add "Finish homework"
quicknote ls
Example:
$ quicknote add "Learn Commander.js"
Note added: "Learn Commander.js"
$ quicknote ls
Your notes:
1. Learn Commander.js
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to open a pull request or check the issues page.
License
ISC © Brian Kija