Skip to content

Latest commit

 

History

History
351 lines (274 loc) · 12.1 KB

File metadata and controls

351 lines (274 loc) · 12.1 KB

Remi - Your AI-Powered Knowledge Hub

Remi App Icon

Lightning-fast access to your most valuable knowledge, right from your macOS menu bar.
Never lose a brilliant idea, useful command, or important note again.

Platform: macOS 12+ Swift 5.10 AI: Groq Powered License: MIT


🎯 What is Remi?

Remi transforms your macOS menu bar into a supercharged knowledge management system. It's your personal assistant for storing, organizing, and instantly accessing:

  • 🤖 AI Prompts you use daily
  • 💻 Terminal commands and code snippets
  • 📝 Quick notes and brilliant ideas
  • 🔧 Useful tips and workflows
  • 📚 Reference materials and documentation

Access everything with a single hotkey. No more hunting through files, bookmarks, or sticky notes.

Remi in action


Your knowledge, instantly accessible from anywhere on macOS


✨ Key Features

🚀 Instant Access

  • Global hotkey (⌘+Shift+R) - summon Remi from anywhere
  • Tab navigation - cycle through nooks with Tab/Shift+Tab
  • Menu bar integration - always one click away
  • Lightning-fast search through all your nooks

🧠 AI-Powered Intelligence

  • Smart editing with Groq AI integration
  • Content enhancement - improve clarity and organization
  • Context-aware suggestions with modern, compact Quick Actions panel
  • Crash-safe operations with robust error handling

📁 Nooks System

Organize your knowledge into focused "Nooks" - think of them as smart, AI-enhanced notepads:

📂 My Nooks/
├── 🤖 AI Prompts/          # Daily prompts for ChatGPT, Claude, etc.
├── 🐳 Docker Commands/     # Container management snippets
├── 🔧 Terminal Shortcuts/  # Bash/Zsh one-liners
├── 💡 Project Ideas/       # Brilliant thoughts and concepts
├── 📝 Meeting Notes/       # Quick capture during calls
└── 🎯 Daily Workflows/     # Step-by-step processes

🎨 Beautiful, Native Design

  • macOS-native interface that feels right at home
  • Dark/Light mode support with persistent user preferences
  • Elegant typography and spacing
  • Smooth animations and modern hover effects
  • Modern card-based UI with gradient backgrounds and subtle shadows

🏃‍♂️ Real-World Use Cases

For Developers

# Docker Nook
🐳 Quick Docker Commands

## Container Management
docker ps -a                    # List all containers
docker logs -f container_name   # Follow logs
docker exec -it container_name bash  # Interactive shell

## Cleanup Commands  
docker system prune -a          # Clean everything
docker volume prune             # Remove unused volumes

## Useful One-liners
docker run --rm -v $(pwd):/app node:16 npm install

For AI Power Users

# AI Prompts Nook
🤖 Daily AI Prompts

## Code Review
"Review this code for security, performance, and best practices. 
Provide specific suggestions with examples."

## Content Creation
"Transform this rough draft into polished, engaging content while 
maintaining the original tone and key messages."

## Problem Solving
"Break down this complex problem into manageable steps and suggest 
the most efficient approach."

For System Administrators

# Server Management Nook
🖥️ Server Commands

## System Monitoring
htop                             # Interactive process viewer
df -h                           # Disk usage
netstat -tulpn                  # Network connections
journalctl -f                   # Follow system logs

## Quick Diagnostics
curl -I website.com             # Check HTTP headers
ping -c 4 8.8.8.8              # Test connectivity

🚀 Getting Started

Installation

  1. Download the latest release from GitHub
  2. Extract the zip file and drag Remi to your Applications folder
  3. Install the unsigned app (since this is a development build):
    • Right-click on Remi.app in Applications
    • Select "Open" from the context menu
    • Click "Open" in the security warning dialog
    • macOS will remember this choice for future launches
  4. Launch Remi - it'll appear in your menu bar
  5. Set your hotkey in Preferences (default: ⌘+Shift+R)

Note: This is an unsigned development build. The right-click → Open method is required only for the first launch to bypass macOS Gatekeeper security.

Quick Setup

  1. Create your first Nook - click the "+" button
  2. Add your content - paste in your most-used commands or notes
  3. Use the hotkey to access instantly from anywhere
  4. Optional: Add Groq API key for AI features


🎯 Latest Features & Improvements

🛡️ Crash-Safe Operations

Remi now includes robust error handling and null-safe operations:

  • Guard statements prevent crashes during undo/redo operations
  • Graceful error handling for network issues and API failures
  • Safe state management with proper validation

🎨 Modern AI Quick Actions Panel

The AI assistance has been completely redesigned:

  • Compact grid layout - 2-column design for better space utilization
  • Elegant hover effects - Smooth animations and visual feedback
  • Modern card design - Gradient backgrounds and subtle shadows
  • Collapsible interface - Clean, unobtrusive when not needed

💾 Persistent User Preferences

Your settings are now remembered across sessions:

  • Markdown/Plain text mode preference saved automatically
  • UI state persistence for Quick Actions panel
  • Theme preferences maintained between app launches

⚡ Native Performance

Streamlined architecture for better performance:

  • Native URLSession replaces third-party networking
  • Optimized animations with SwiftUI best practices
  • Efficient memory usage with proper state management

Pro Tips

  • Use descriptive nook names like "Docker Commands" or "AI Prompts"
  • Organize by context rather than by type
  • Keep frequently used items at the top of each nook
  • Tab through nooks to quickly browse your collection
  • Use the AI Quick Actions for instant content improvement
  • Enable markdown preview for rich text formatting
  • Leverage undo/redo (⌘Z/⌘⇧Z) for safe editing

🎛️ Configuration

Global Hotkey

Customize your hotkey in Settings:

  • Default: ⌘ + Shift + R
  • Choose any combination that works for your workflow

AI Integration

Add your Groq API key for intelligent features:

  1. Get a free key from console.groq.com
  2. Paste it in Remi's Settings
  3. Enjoy AI-powered editing and suggestions

Launch at Login

Enable in Settings to have Remi ready when you start your Mac.


🏗️ Technical Architecture

Remi is built with modern macOS development practices and focuses on native performance:

🏛️ Architecture Overview
├── 🎯 SwiftUI Interface       # Native, responsive UI with modern components
├── 🧠 AI Integration         # Native URLSession + Groq API
├── 📁 File-based Storage     # Simple, portable nooks
├── ⚡ Global Hotkey System   # System-wide accessibility
├── 🎨 Theme Management       # Dark/Light mode with persistence
├── 🛡️ Error Handling        # Robust, crash-safe operations
└── 🔄 Undo/Redo System      # Native UndoManager integration

Project Structure

remi/
├── App/                     # App lifecycle and configuration
│   ├── AppDelegate.swift    # Menu bar setup and app coordination
│   └── remiApp.swift       # SwiftUI app entry point
├── Core/                    # Business logic and data management
│   ├── Models/             # Data models (Nook)
│   └── Services/           # Core services (AI, networking, settings)
├── UI/                     # User interface components
│   ├── Theme/              # Theme system and color management
│   ├── ViewModels/         # MVVM architecture
│   └── Views/              # SwiftUI views and components
│       ├── Components/     # Reusable UI components
│       ├── Reusable/       # Generic reusable views
│       └── Settings/       # Settings and configuration views
└── Utils/                  # Utilities and helpers

Core Technologies

  • SwiftUI - Modern, declarative UI framework
  • Native URLSession - Reliable, lightweight networking
  • HotKey - Global keyboard shortcut management
  • Groq AI - Fast, efficient language model integration
  • UserDefaults - Persistent user preferences
  • NSUndoManager - Native undo/redo functionality

🤝 Contributing

We welcome contributions! Here's how you can help:

Development Setup

# Clone the repository
git clone https://github.com/Ashref-dev/remi-notes-project.git
cd remi-notes-project

# Open in Xcode
open remi.xcodeproj

# Build and run
⌘ + R

Ways to Contribute

  • 🐛 Report bugs or suggest features
  • 📝 Improve documentation
  • 🎨 Design improvements
  • 🔧 Code contributions
  • 🌍 Localization support

🗺️ Roadmap

Coming Soon

  • 🔄 Sync across devices via iCloud
  • 📱 iOS companion app
  • 🏷️ Tags and smart filtering
  • 📊 Usage analytics and insights
  • 🔗 Integration with popular tools (Notion, Obsidian)
  • 🎯 Enhanced AI workflows with custom prompts
  • ⌨️ Nook hotkeys (⌘+Shift+1-9) - instantly jump to any nook

Recent Improvements

  • ⌨️ Tab navigation through nooks with Tab/Shift+Tab
  • 🎨 Improved nook cards with better visibility and simplified design
  • ✏️ Repositioned edit button for better accessibility
  • 🛡️ Crash-safe undo/redo operations
  • 🎨 Modern AI Quick Actions panel with grid layout
  • Native networking (removed Alamofire dependency)
  • 💾 Persistent user preferences for UI state
  • 🖱️ Enhanced hover effects and smooth animations
  • 📝 Improved markdown/plaintext toggle with persistence

Future Vision

  • 🤖 Advanced AI workflows
  • 👥 Team collaboration features
  • 🔌 Plugin system for extensibility
  • 🎯 Smart suggestions based on context

💬 Community & Support


📄 License

Remi is open source software licensed under the MIT License. See LICENSE for details.


🙏 Acknowledgments

Built with ❤️ using:

Special thanks to the Swift community for excellent libraries and continuous innovation in macOS development.


Transform your workflow with Remi - where knowledge meets convenience.

⬇️ Download Latest Release · 💬 Join Community · 🐛 Report Bug