Clarity

A minimalist terminal-based note-taking application that helps you organize your thoughts with simplicity and efficiency.

Features

• 📝 Create and edit markdown notes
• 📂 List and search through your notes
• 💾 Auto-saving functionality
• 🗑️ File deletion support
• 🖥️ Cross-platform support (Windows, Linux, macOS)
• ⌨️ Intuitive keyboard shortcuts

Installation

Windows

# Download the latest release
curl -LO https://github.com/yourusername/clarity/releases/download/v0.1.0/clarity-windows-amd64-v0.1.0.exe

# Move to Program Files
Move-Item clarity-windows-amd64-v0.1.0.exe "C:\Program Files\Clarity\clarity.exe"

# Add to PATH (optional)
$oldPath = [Environment]::GetEnvironmentVariable('Path', 'Machine')
[Environment]::SetEnvironmentVariable('Path', "$oldPath;C:\Program Files\Clarity", 'Machine')

Linux

# Download the latest release
curl -LO https://github.com/yourusername/clarity/releases/download/v0.1.0/clarity-linux-amd64-v0.1.0
chmod +x clarity-linux-amd64-v0.1.0
sudo mv clarity-linux-amd64-v0.1.0 /usr/local/bin/clarity

macOS

# Download the latest release
curl -LO https://github.com/yourusername/clarity/releases/download/v0.1.0/clarity-darwin-amd64-v0.1.0
chmod +x clarity-darwin-amd64-v0.1.0
sudo mv clarity-darwin-amd64-v0.1.0 /usr/local/bin/clarity

Usage

Launch Clarity from your terminal:

clarity

Keyboard Shortcuts

Shortcut	Action
Ctrl+N	Create new note
Ctrl+L	List all notes
Ctrl+S	Save current note
Ctrl+D	Delete selected note
Esc	Go back
Ctrl+Q	Quit application

File Storage

Notes are stored in plain text format in the .clarity directory within your home folder:

• Windows: %USERPROFILE%\.clarity
• Linux/macOS: ~/.clarity

Building from Source

Requirements:

• Go 1.21 or higher
• Git

# Clone repository
git clone https://github.com/yourusername/clarity.git
cd clarity

# Build
go build

# Run
./clarity

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some 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 file for details.

Acknowledgments

Built with:

• Bubble Tea
• Bubbles
• Lip Gloss

Support

If you encounter any issues or have questions, please open an issue.