mee

A fast, extensible terminal launcher with a plugin system written in Go.

Features

• Terminal UI - Clean interface powered by Bubble Tea
• Plugin System - Extend functionality with Go plugins (Yaegi interpreter)
• Parallel Search - All plugins execute concurrently for fast results
• Trigger-based Filtering - Plugins with triggers only run when needed
• Fuzzy Matching - Built-in scoring for search results
• Cross-platform - macOS, Linux, Windows support

Installation

go build -o mee ./mee.go

Usage

Setup

# Initial setup with default plugins
./mee setup --with-plugins

# Check setup status
./mee check

Interactive Mode

./mee

Command Line

# Direct query
./mee "Safari"

# Pipe input
echo "100+50" | ./mee

Plugin Management

# Install plugin from GitHub
./mee plugin add https://github.com/user/repo

# List installed plugins
./mee plugin list

# Remove a plugin
./mee plugin remove <plugin-name>

# Enable/Disable a plugin
./mee plugin enable <plugin-name>
./mee plugin disable <plugin-name>

# Update plugins
./mee plugin update

History Management

# Show recent history
./mee history list

# Search history
./mee history search <query>

# Show popular queries
./mee history top

# Clear history
./mee history clear

# Export/Import history
./mee history export [file]
./mee history import <file>

Keyboard Shortcuts

Key	Action
↑ ↓	Navigate results
Tab	Complete trigger
Enter	Select item
Esc / Ctrl+C	Quit

Built-in Plugins

Plugin	Description	Trigger
apps	Launch applications	-
calc	Calculator	-
rpn	RPN Calculator	-
web	Web search	wiki:, g:, gh:, ddg:, yt:, so:,
emoji	Emoji search	emoji:
unixtime	Unix timestamp converter	unix:

Configuration

Config file: ~/.config/mee/config.yaml

app:
  mode: interactive # "daemon" or "interactive"
  startup: false # start on system startup
  log_level: info # "debug", "info", "warn", "error"

display:
  theme: auto # "auto", "light", "dark"
  max_results: 50
  list_height: 15

plugins:
  dirs:
    - ~/.config/mee/plugins
    - /usr/local/share/mee/plugins
  runtime_default: yaegi # "yaegi", "wasm", "native"

search:
  fuzzy_threshold: 0.7 # 0.0-1.0
  history_boost: true # boost results by history

storage:
  db_path: ~/.local/share/mee/mee.db

registry:
  cache_dir: ~/.cache/mee/plugins

# Optional custom colors
colors:
  title: "#00ff00"
  input: "#ffffff"
  mark: "#ff00ff"
  item: "#cccccc"
  sub: "#888888"
  help: "#666666"

Creating Plugins

Plugin Structure

plugins/myplugin/
├── manifest.json
└── myplugin.go

manifest.json

{
	"name": "myplugin",
	"version": "1.0.0",
	"trigger": ">", // Optional: prefix to activate plugin
	"script": "myplugin.go",
	"description": "My custom plugin"
}

myplugin.go

package main

import (
	"encoding/json"
	"strings"
)

type ResultItem struct {
	ID       string `json:"id"`
	Title    string `json:"title"`
	Subtitle string `json:"subtitle"`
	Action   string `json:"action"`
	Payload  string `json:"payload"`
	Score    int    `json:"score"`
}

type ResultSet struct {
	Items        []ResultItem `json:"items"`
	ProviderName string       `json:"provider_name"`
}

// Required: Search function
func Search(query string) string {
	// Early return if this plugin doesn't handle the query
	if !shouldHandle(query) {
		return ""
	}

	rs := ResultSet{
		Items: []ResultItem{{
			ID:       "myplugin:result",
			Title:    "Result Title",
			Subtitle: "Subtitle",
			Action:   "open",   // "open", "launch", "copy", "print", "trigger"
			Payload:  "value",
			Score:    100,
		}},
		ProviderName: "myplugin",
	}

	data, _ := json.Marshal(rs)
	return string(data)
}

func shouldHandle(query string) bool {
	// Your logic here
	return strings.HasPrefix(query, ">")
}

Actions

Action	Description
open / launch	Open URL or launch application
copy	Copy payload to clipboard
print	Print to stdout
trigger	Activate another plugin trigger

Tips for Fast Plugins

1. Early return - Check if query is relevant before processing
2. Keep it simple - Avoid expensive operations
3. Use triggers - Set a trigger prefix to avoid unnecessary calls

Architecture

mee.go                 # Entry point
cmd/
├── mee/
│   ├── historycmd/    # History management commands
│   └── plugincmd/    # Plugin management commands
pkg/
├── core/
│   ├── config.go      # Configuration loader
│   └── ranker.go      # Search ranking with parallel execution
├── database/
│   ├── database.go    # SQLite database operations
│   ├── history.go     # History data management
│   └── plugin.go      # Plugin metadata storage
├── platform/
│   └── platform.go    # OS-specific utilities
├── plugin/
│   └── plugin.go      # Yaegi-based plugin manager
├── provider/
│   └── provider.go    # Provider interface & fuzzy matching
├── setup/
│   └── setup.go       # Initial setup & installation
└── tui/
    └── tui.go         # Terminal UI (Bubble Tea)
plugins/               # Built-in plugins

Performance

• Parallel Execution: All plugins search concurrently via goroutines
• Trigger Filtering: Plugins with triggers only activate on matching prefixes
• Shared Symbols: Interpreter stdlib symbols are shared across plugins
• Lazy Loading: Plugins are only initialized when first searched
• Sandbox: Configurable timeout and memory limits per plugin
• History Boost: Frequently used results are ranked higher

License

MIT