ink-notes 🖋️

A modern CLI note-taking application built with Python, Click, SQLAlchemy, Pydantic, and Rich.

Store, organize, search, update, and manage notes directly from your terminal with a clean and colorful interface.

---

✨ Features

• Create notes with titles, content, and tags.
• Update existing notes.
• Search notes by title, content, or tags.
• View individual notes by ID.
• Delete notes with confirmation prompts.
• SQLite-powered persistent storage via SQLAlchemy.
• Rich terminal tables and colored output.
• Input validation using Pydantic.
• Cross-platform support (Windows, Linux, macOS).

---

📦 Installation

You can install ink-notes from PyPI:

pip install ink-notes

Or install from source:

git clone https://github.com/a0x0p/ink.git cd ink-notes pip install .

🚀 Usage

Once installed, use the ink command:

Show help

ink --help

Create a note

ink add "Hello, Ink!"

Create a note with tags

ink add "Hello, Ink!" --tags "comma-seperated words."

List notes

ink lst

View a note by ID

ink view <note_id>

Search notes

ink search "keyword"

Delete a note

ink delete <note_id>

🧪 Running Tests

If you want to run the unit tests:

python -m pytest -v

🤝 Contributing

Contributions are welcome! Feel free to fork this repo, open issues, or submit PRs.

📜 License

MIT License © 2025 a0x0p

---