snip

📦 SNIP - Code Snippet Manager

A beautiful terminal-based code snippet manager built with Go and Bubble Tea

✨ Features

• 🎨 Beautiful TUI - Interactive terminal interface with tabbed navigation
• 📁 Category Management - Organize snippets into logical categories
• 🏷️ Tag System - Multi-tag support for flexible organization
• 🔍 Full-Text Search - Quickly find snippets by title, description, or code
• ⌨️ Syntax Highlighting - Code editor with line numbers
• 🚀 Dual Interface - Use interactive TUI or traditional CLI commands

📸 Screenshots

Interactive TUI Mode

  ╭────────────────────╮╭────────────────────╮╭────────────────────╮╭────────────────────╮
  │       ⌨ Home       ││     Categories     ││        Tags        ││      Snippets      │
  │                    └┴────────────────────┴┴────────────────────┴┴────────────────────┤
  │                                                                                      │
  │    ████████                                                                          │
  │  ██        ██                                                                        │
  │  ██  ██  ██  ██                                                                      │
  │  ██  ██  ██  ██                                                                      │
  │  ██          ██                                                                      │
  │  ██  ████████ ██                                                                     │
  │  ████      ████                                                                      │
  │                                                                                      │
  │  SNIP - Code Snippet Manager                                                         │
  │                                                                                      │
  │  Welcome! Use the tabs above to navigate:                                            │
  │  - Home - You are here                                                               │
  │  - Categories - Manage snippet categories                                            │
  │  - Tags - Manage snippet tags                                                        │
  │  - Snippets - Manage code snippets                                                   │
  │                                                                                      │
  │  Navigation:                                                                         │
  │    Ctrl+F      - Toggle between Interactive and Navigation mode                      │
  │    Tab         - Next tab (in Navigation mode)                                       │
  │    Shift+Tab   - Previous tab (in Navigation mode)                                   │
  │    ←/→         - Switch tabs (in Navigation mode)                                    │
  │    PgUp/PgDn   - Scroll content (in Interactive mode)                                │
  │    Ctrl+←/→    - Scroll horizontally                                                 │
  │    Ctrl+C      - Quit                                                                │
  │                                                                                      │
  │  Mode Indicators:                                                                    │
  │    ⌨ (green)   - Interactive mode: Components receive keyboard input                 │
  │    ⇄ (blue)    - Navigation mode: Tab switching and scrolling enabled                │
  └──────────────────────────────────────────────────────────────────────────────────────┘

  Ctrl+F: toggle mode | Ctrl+C: quit

🚀 Quick Start

Installation

Download Pre-built Binary

Download the latest release for your platform from the releases page.

Linux/macOS:

# Download and install (replace VERSION with actual version)
curl -L https://github.com/7-Dany/snip/releases/download/vVERSION/snip-linux-amd64 -o snip
chmod +x snip
sudo mv snip /usr/local/bin/

Windows (PowerShell):

# Download from releases page and add to PATH

Build from Source

# Clone the repository
git clone https://github.com/7-Dany/snip.git
cd snip

# Build and install
make build
sudo make install

# Or use go install
go install

First Run

# Launch interactive TUI
snip

# Or use CLI commands, note: to work with commands snip must be followed with arguments.
snip snippet create
snip snippet list
snip help

📖 Usage

Interactive TUI Mode

The recommended way to use SNIP is through the interactive TUI:

snip

Keyboard Shortcuts:

In Code Editor:

CLI Commands

Snippet Management

# Create a new snippet interactively
snip snippet create

# List all snippets
snip snippet list

# List snippets with filters
snip snippet list --language go
snip snippet list --category 1
snip snippet list --tag 2

# Show a specific snippet
snip snippet show 5

# Update a snippet
snip snippet update 5

# Delete a snippet
snip snippet delete 5

# Search snippets
snip snippet search "binary tree"

Category Management

# Create a category
snip category create algorithms
snip category create  # Interactive mode

# List all categories
snip category list

# Delete a category
snip category delete 3

Tag Management

# Create a tag
snip tag create performance
snip tag create  # Interactive mode

# List all tags
snip tag list

# Delete a tag
snip tag delete 7

Help

# General help
snip help

# Topic-specific help
snip help snippet
snip help category
snip help tag

🏗️ Architecture

snip/
├── cmd/                   # Application entry points
│   └── main.go            # Main CLI application
├── internal/
│   ├── cli/               # CLI layer
│   │   ├── commands/      # CLI command handlers
│   │   ├── components/    # Reusable Bubble Tea UI components
│   │   └── tui/           # Terminal UI implementation
│   ├── domain/            # Business logic and entities
│   └── storage/           # Data persistence layer
└── main.go

Key Components

• Domain Layer: Pure business logic (snippets, categories, tags)
• Storage Layer: JSON-based repositories with transaction support
• CLI Commands: Traditional command-line interface
• TUI: Interactive terminal interface using Bubble Tea
• Components: Reusable UI widgets (tables, editors, menus, dialogs)

🧪 Testing

Test Coverage

SNIP maintains comprehensive test coverage across its core components:

# Run all tests
make test

# Run tests with coverage report
go test ./... -cover

# Generate detailed coverage report
go test ./... -coverprofile=coverage.out
go tool cover -html=coverage.out

Testing Approach

✅ What We Test

• Business Logic: All domain entities, validation rules, and state management
• Data Persistence: Repository CRUD operations, queries, and transactions
• CLI Commands: Command parsing, argument validation, and error handling
• Error Paths: Database errors, invalid input, and edge cases

⚠️ What We Don't Test (And Why)

Interactive TUI Components are intentionally excluded from automated testing for the following reasons:

1. Framework Limitations: Bubble Tea's event-driven architecture and terminal rendering make unit testing impractical without extensive mocking
2. Testing Complexity: UI interactions involve complex state machines, terminal dimensions, and timing-dependent updates that are difficult to reproduce in tests
3. Visual Nature: TUI correctness is inherently visual - automated tests can't validate layout, colors, or user experience
4. Rapid UI Changes: UI/UX iterations are frequent and would require constant test maintenance
5. Manual QA is More Effective: Interactive components are better validated through:
   • Manual testing during development
   • Smoke tests before releases
   • User feedback and bug reports

User Input Prompts (like delete confirmations) are also not fully tested because:

• They rely on fmt.Scanln() which reads from stdin
• Mocking stdin in Go tests is complex and fragile
• These are simple UI flows with minimal business logic
• Refactoring for testability would add unnecessary complexity

🎯 Testing Strategy

Our testing strategy focuses on:

• High-value tests: Core business logic and data integrity
• Fast feedback: Unit tests run in milliseconds
• Maintainability: Tests are simple and don't require complex mocks
• Confidence: Critical paths have multiple test scenarios

The combination of automated tests for logic layers and manual testing for UI provides the best balance of confidence and development velocity.

Running Tests

# Run all tests
go test ./...

# Run tests with verbose output
go test -v ./...

# Run tests for specific package
go test ./internal/domain/...
go test ./internal/storage/...
go test ./internal/cli/commands/...

# Run tests with race detection
go test -race ./...

# Generate coverage report
go test -coverprofile=coverage.out ./...
go tool cover -func=coverage.out

# View coverage in browser
go tool cover -html=coverage.out

Test Organization

internal/
├── domain/
│   ├── snippet_test.go      # Domain entity tests
│   ├── category_test.go
│   └── tag_test.go
├── storage/
│   ├── snippet_repo_test.go # Repository tests
│   ├── category_repo_test.go
│   └── tag_repo_test.go
└── cli/
    └── commands/
        ├── snippet_test.go   # CLI command tests
        ├── category_test.go
        └── tag_test.go

🛠️ Development

Prerequisites

• Go 1.25 or higher

Building

# Build for current platform
make build

# Build for all platforms
make build-all

# Run tests
make test

# Clean build artifacts
make clean

Development Workflow

1. Make your changes
2. Run tests: make test
3. Check coverage: go test -cover ./...
4. Test manually with: go run main.go
5. Build: make build

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Contribution Guidelines

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Write tests for new functionality (where applicable)
4. Ensure all tests pass (go test ./...)
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

What to Test

• ✅ Do add tests for: Domain logic, repository operations, CLI command handlers
• ⚠️ Optional for: TUI components (manual testing is acceptable)
• ✅ Always test: Error handling and edge cases

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with Bubble Tea - amazing TUI framework
• Uses Lipgloss for styling
• Inspired by the need for a simple, elegant snippet manager

📬 Contact

• GitHub: @7-Dany
• Project Link: https://github.com/7-Dany/snip

⭐ If you find this project useful, please consider giving it a star!