1 unstable release
new 0.2.0 | Feb 28, 2025 |
---|
#603 in Command line utilities
21KB
423 lines
snb
Superfast, minimalist note-taking from your terminal [^1]
A lightning-fast CLI note-taking tool written in Rust, inspired by nb. Perfect for developers who want to quickly capture thoughts without leaving their terminal.
Features
- 🚀 Blazingly fast performance
- 📝 Simple markdown-based note creation and editing
- 🔍 Quick note lookup and listing
- ⌨️ Terminal-first workflow
- 📂 Minimal configuration required
Installation
Via Cargo
cargo install snb
Dependencies
- Rust 1.70 or higher
- A text editor (set via
EDITOR
environment variable)
Usage
Notes Management
# Create a new note
snb add "This is a note" --title "My Awesome note"
# List all notes
snb
# Edit note by ID
snb edit <id>
# Delete note by ID
snb delete <id>
Note: Deleted note IDs are preserved (holes in sequence) for consistency with nb behavior.
Configuration
For now, set the EDITOR
environment variable manually.
Roadmap
- Folder management
- Bookmark support
- Todo list functionality
- Index rebuilding
- Note search and filtering
- Tags support
- Configuration file support
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -am 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
Please ensure your PR:
- Follows the existing code style
- Includes tests if applicable
- Updates documentation as needed
License
This project is licensed under the MIT License - see the LICENSE file for details.
[^1]: Name suggested by https://claude.ai/ 🙏
Dependencies
~2.1–9MB
~82K SLoC