https://github.com/armand-sauzay/note
✍️ take notes in your terminal ✍️
https://github.com/armand-sauzay/note
bubbletea go note terminal tui writing
Last synced: 8 months ago
JSON representation
✍️ take notes in your terminal ✍️
- Host: GitHub
- URL: https://github.com/armand-sauzay/note
- Owner: armand-sauzay
- License: mit
- Created: 2024-11-16T21:17:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-16T23:51:49.000Z (11 months ago)
- Last Synced: 2025-03-29T23:09:56.818Z (8 months ago)
- Topics: bubbletea, go, note, terminal, tui, writing
- Language: Go
- Homepage:
- Size: 4.85 MB
- Stars: 113
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - note - A modern terminal-based note-taking application built with Bubble Tea and Lip Gloss to organize your thoughts with style. (<a name="note-taking"></a>Note taking)
README
Note ✍️
A modern terminal-based note-taking application built with [Bubble Tea](https://github.com/charmbracelet/bubbletea) and [Lip Gloss](https://github.com/charmbracelet/lipgloss). Organize your thoughts with style right from your terminal.
## ✨ Features
- 📝 Create and edit markdown notes
- 🗂️ Organize notes in folders
- 🎨 Beautiful TUI with syntax highlighting
- 📱 Responsive layout with adjustable sidebar
- 🗑️ Archive unused notes
- ⌨️ Vim-style keybindings
- 🎯 Focus mode without sidebar
- 🔍 Preview markdown rendering
- ⚡ Fast and lightweight
## 📦 Installation
### Using Homebrew (macOS & Linux)
```bash
brew tap armand-sauzay/homebrew-tap
brew install note
```
### Using Go
```
go install github.com/armand-sauzay/note@latest
```
### From Source
```
git clone https://github.com/armand-sauzay/note.git
cd note
go install .
```
## 🚀 Usage
## ⚙️ Configuration
### Keybindings
- `j/k` or `↑/↓`: Navigate notes
- `h/l` or `←/→`: Collapse/expand folders
- `enter`: Edit note/rename folder
- `n`: Create new note
- `N`: Create new folder
- `tab`: Toggle sidebar
- `backspace`: Archive note/folder
- `q` or `ctrl+c`: Quit
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🚧 Roadmap
- [ ] Custom themes
- [ ] Tags
- [ ] Sorting notes
- [ ] Search notes
- [ ] Export notes