pluely

pluely

The Open Source Alternative to Cluely - A lightning-fast, privacy-first AI assistant that works seamlessly during meetings, interviews, and conversations without anyone knowing. Built with Tauri for native performance, just 10MB. Completely undetectable in video calls, screen shares, and recordings.

Stars: 575

Visit
 screenshot

Pluely is a versatile and user-friendly tool for managing tasks and projects. It provides a simple interface for creating, organizing, and tracking tasks, making it easy to stay on top of your work. With features like task prioritization, due date reminders, and collaboration options, Pluely helps individuals and teams streamline their workflow and boost productivity. Whether you're a student juggling assignments, a professional managing multiple projects, or a team coordinating tasks, Pluely is the perfect solution to keep you organized and efficient.

README:

Pluely ๐Ÿš€

pluely

Open Source Tauri React License

๐Ÿ’ Support the Project & Connect

Buy Me a Coffee ย  Hire Me

Socials: GitHub Twitter Website LinkedIn

The Open Source Alternative to Cluely - A lightning-fast, privacy-first AI assistant that works seamlessly during meetings, interviews, and conversations without anyone knowing.

This is the open source version of the $15M company Cluely ๐ŸŽฏ. Experience the same powerful real-time AI assistance, but with complete transparency, privacy, and customization control.

๐Ÿ“ฅ Download Pluely

๐Ÿš€ Get the Latest Release

Download for macOS ย  Download for Linux ย  Download for Windows

GitHub Release ย  GitHub Downloads

Available formats: .dmg (macOS) โ€ข .msi (Windows) โ€ข .exe (Windows) โ€ข .deb (Linux) โ€ข .rpm (Linux) โ€ข .AppImage (Linux)


โšก The Ultimate Lightweight AI Companion

๐ŸŽฏ Just 10MB โ€ข Always On Display โ€ข One Click Away

The world's most efficient AI assistant that lives on your desktop

๐Ÿชถ Ultra Lightweight ๐Ÿ“บ Always Visible โšก Instant Access
Only ~10MB total app size Translucent overlay on any window One click to activate AI assistance
27x smaller than Cluely (~270MB) Always on top, never intrusive Overlaps seamlessly with your workflow
50% less compute power usage Perfect transparency level Ready when you need it most

๐Ÿ“Š Pluely vs Original Cluely

Feature ๐ŸŸข Pluely (Open Source) ๐Ÿ”ด Original Cluely
App Size ~10MB โšก ~270MB ๐ŸŒ
Size Difference 27x Smaller ๐Ÿชถ Bloated with unnecessary overhead
Compute Usage 50% Less CPU/RAM ๐Ÿ’š Heavy resource consumption
Startup Time <100ms โšก Several seconds
Privacy 100% Local with your LLM ๐Ÿ”’ Data sent to servers
Cost Free & Open Source ๐Ÿ’ $15M company pricing ๐Ÿ’ธ

Features

โŒจ๏ธ Keyboard Shortcuts

Pluely comes with powerful global keyboard shortcuts that work from anywhere on your system:

Shortcut macOS Windows/Linux Function
Toggle Window Cmd + \ Ctrl + \ Show/Hide the main window + app icon (based on settings)
Voice Input Cmd + Shift + A Ctrl + Shift + A Start voice recording
Screenshot Cmd + Shift + S Ctrl + Shift + S Capture screenshot
System Audio Cmd + Shift + M Ctrl + Shift + M Toggle system audio capture

๐ŸŽฏ Always on TOP

Control whether the Pluely window stays above all other applications for instant access:

  • Enabled: : Window always appears on top of other applications
  • Disabled: Window behaves like normal applications
  • Settings Control: Toggle in Settings โ†’ Always On Top Mode
  • Independent Control:: Works separately from stealth features
  • Perfect for: Quick access during meetings, presentations, or when you need instant AI assistance

Perfect for instant access during sensitive meetings and conversations - window stays above all applications for seamless AI assistance!

๐ŸŽฏ App Icon Stealth Mode

Complete stealth mode control integrated with main toggle:

  • Show Mode (Default): App icon remains visible in dock/taskbar when window is hidden
  • Hide Mode: App icon completely disappears from dock/taskbar when window is hidden (app keeps running in background)
  • Settings Control: Configure dock/taskbar icon visibility in Settings โ†’ App Icon Visibility
  • Auto-Integration: Works automatically with main toggle shortcut (Cmd+\ / Ctrl+\) based on your settings
  • Cross-Platform: Works seamlessly on macOS (ActivationPolicy::Accessory), Windows (skip_taskbar), and Linux (skip_taskbar)

Perfect for maximum discretion during sensitive meetings and conversations - the app icon disappears from dock/taskbar but app remains fully functional!


๐ŸŽฏ System Audio Capture

Transform any audio on your system into an intelligent AI assistant with real-time transcription and contextual help:

  • Real-Time AI Assistant: 8 specialized modes for meetings, interviews, presentations, learning, and more
  • Background Processing: Captures system audio continuously with smart context detection
  • Multi-Scenario Support: Meeting insights, interview help, translation, presentation coaching, and learning assistance
  • Cross-Platform: Works on macOS, Windows, and Linux with platform-specific audio routing
  • Settings Control: Toggle system audio capture in Settings โ†’ Audio section
  • AI Integration: Seamlessly connects transcription to AI models for instant responses

Turn any audio into your personal AI assistant - from Zoom calls to podcasts, get intelligent help in real-time!

Why Setup Required?

๐Ÿ”’ Security by Design: Operating systems block direct system audio access for privacy protection - this is universal across all platforms and applications.

โš™๏ธ Quick Setup Process:

  • macOS: Install BlackHole (free) + Audio MIDI Setup (5 min)
  • Windows: Enable built-in Stereo Mix OR install VB-Cable (free) (3 min)
  • Linux: Use built-in PulseAudio monitors (usually works out-of-box)

๐Ÿ“– Complete Audio Setup Guide โ€ข Step-by-step for all platforms


๐ŸŽฅ Live Demos

๐Ÿ’ฌ Input Methods Demo

Experience multiple input methods including text entry, and image pasting:

Input Example 1 Input Example 2
Input Demo 1 Input Demo 2
Clean, intuitive text interface with markdown support for seamless conversation Image pasting functionality that automatically adds files to attachments for AI analysis

๐Ÿ“ธ Screenshot Demo

Capture and analyze screenshots with automatic or manual modes for different use cases:

Manual Mode Screenshot
Manual Mode Screenshot
Screenshots are captured and automatically added to your attached files for manual submission with your own prompt
Auto Mode Screenshot
Auto Mode Screenshot
Screenshots are automatically submitted to AI using your custom prompt for instant analysis

๐ŸŽค Voice Input Demo

Speak naturally and get instant AI responses with advanced voice activity detection:

Voice Input Demo

Real-time speech-to-text using OpenAI Whisper with automatic voice detection - just speak and get AI responses


๐Ÿ“š Conversation History

Keep track of all your AI interactions with persistent conversation history:

Conversation History Demo

Browse through previous conversations, search chat history, and continue where you left off


๐Ÿ”ง Setup

๐Ÿ”ง AI Provider Setup

Get started with your preferred AI provider in seconds. Pluely supports all major LLM providers with dynamic model fetching, custom providers, and seamless integration:

Custom Provider Setup OpenAI Setup
Custom provider Setup OpenAI API Setup
Add your custom provider and select the provider from AI providers in the AI Providers section, then enter your API key and AI model Add your OpenAI API key and select from dynamically fetched models including GPT-4, GPT-4 Turbo, and more
Google Gemini Setup xAI Grok Setup
Google Gemini API Setup xAI Grok API Setup
Connect to Google Gemini with your API key and choose from available models like Gemini Pro Integrate with xAI Grok - dynamically fetches available models for seamless AI assistance
Anthropic Claude Setup Additional AI Providers
Anthropic Claude API Setup ๐Ÿ”ธ Mistral AI
๐Ÿ”ธ Groq
๐Ÿ”ธ Cohere
๐Ÿ”ธ Perplexity AI
Enter your Claude API key and model name manually for powerful AI conversations These providers are also available in the AI Providers settings for more options

โš™๏ธ Provider Configuration

Each provider comes pre-configured with optimal settings:

  • ๐Ÿ”„ Dynamic Model Fetching: Automatically fetch latest models from OpenAI, xAI, Gemini, Mistral, and Groq
  • ๐ŸŽฏ Manual Model Selection: For Claude and Cohere, enter your preferred model name
  • ๐Ÿ” Secure Authentication: API keys stored locally in browser storage
  • ๐Ÿ“ก Streaming Support: Real-time responses for all providers
  • ๐Ÿ–ผ๏ธ Multi-Modal: Image analysis support where available
  • โšก Fast Integration: One-click setup for instant AI assistance

๐Ÿš€ Quick Setup Guide

  1. Choose Your Provider: Select from the comprehensive list in Settings
  2. Enter API Key: Add your provider's API key securely
  3. Select Model: Choose from dynamically fetched models or enter manually
  4. Start Chatting: Begin your AI-powered conversations immediately

๐Ÿ”ง Custom Provider Support

For providers not in our list, use the custom provider option:

  • Add any OpenAI-compatible API endpoint
  • Configure custom authentication methods
  • Set up your own response parsing
  • Full flexibility for any LLM service

๐ŸŽค Speech-to-Text Provider Setup

Pluely supports advanced voice input with multiple speech-to-text providers for accurate, real-time transcription. Choose from industry-leading STT services or add your own custom provider:

Provider Auth Type Features Model
๐ŸŽค OpenAI Whisper Bearer Token High accuracy, fast processing whisper-1
โšก Groq Whisper Bearer Token Ultra-fast transcription whisper-large-v3
๐Ÿ”Š ElevenLabs STT xi-api-key Natural language processing scribe_v1
๐Ÿ” Google Speech-to-Text Bearer Token Advanced language detection N/A
๐ŸŽฏ Deepgram STT Bearer Token Real-time processing nova-2
๐Ÿง  IBM Watson STT Basic API Key Enterprise-grade accuracy en-US_BroadbandModel
โ˜๏ธ Azure Speech-to-Text Subscription Key Cloud-native processing N/A
๐ŸŽต Speechmatics Bearer Token High accuracy for various languages N/A
๐Ÿค– Zhipu GLM-ASR Bearer Token Chinese language specialist glm-asr
๐Ÿš€ Doubao STT Bearer Token Fast Chinese transcription whisper-1

๐ŸŽ™๏ธ STT Provider Features

  • ๐ŸŽฏ Real-time Processing: Instant speech recognition with voice activity detection
  • ๐ŸŒ Multi-Language Support: Choose providers optimized for specific languages
  • โšก Fast & Accurate: Industry-leading transcription accuracy and speed
  • ๐Ÿ”’ Secure Authentication: API keys stored locally and securely
  • ๐ŸŽจ Seamless Integration: Works with Pluely's voice input features

๐Ÿ› ๏ธ Custom STT Provider Setup

Can't find your preferred speech-to-text provider? Add custom STT providers with full configuration control:

  • ๐Ÿ”ง Flexible API Integration: Support for any REST API endpoint
  • ๐Ÿ” Custom Authentication: Bearer tokens, API keys, or custom headers
  • ๐Ÿ“ Request Customization: Configure audio formats, parameters, and headers
  • ๐ŸŽฏ Response Parsing: Define custom response paths for transcription text
  • โš™๏ธ Advanced Configuration: Set up audio formats, sample rates, and more

๐Ÿš€ Voice Input Quick Start

  1. Select Provider: Choose from the comprehensive STT provider list
  2. Configure API: Enter your provider's API credentials securely
  3. Test Connection: Verify your setup with a quick voice test
  4. Start Speaking: Use voice input seamlessly in your conversations

๐ŸŒŸ Why Pluely?

๐Ÿ‘ป Completely Undetectable & Stealth

๐ŸŽฏ The Ultimate Stealth AI Assistant - Invisible to Everyone

Pluely is engineered to be completely invisible during your most sensitive moments:

  • ๐Ÿ” Undetectable in video calls - Works seamlessly in Zoom, Google Meet, Microsoft Teams, Slack Huddles, and all other meeting platforms
  • ๐Ÿ“บ Invisible in screen shares - Your audience will never know you're using AI assistance
  • ๐Ÿ“ธ Screenshot-proof design - Extremely difficult to capture in screenshots due to translucent overlay
  • ๐Ÿข Meeting room safe - Won't appear on projectors or shared screens
  • ๐ŸŽฅ Recording invisible - Doesn't show up in meeting recordings or live streams
  • โšก Instant hide/show - Overlaps with any window on your PC/Desktop for quick access

Perfect for confidential scenarios where discretion is absolutely critical.

๐Ÿ”ฅ Blazingly Fast with Tauri

Built with Tauri, Pluely delivers native desktop performance with minimal resource usage:

  • Instant startup - launches in milliseconds
  • 10x smaller than Electron apps (~10MB vs ~100MB)
  • Native performance - no browser overhead
  • Memory efficient - uses 50% less RAM than web-based alternatives
  • Cross-platform - runs natively on macOS, Windows, and Linux

๐Ÿ›ก๏ธ Privacy-First Architecture

Unlike cloud-based solutions, Pluely keeps everything local:

  • Your data never touches any servers - all processing happens locally and with your LLM provider
  • API keys stored securely in your browser's localStorage
  • No telemetry or tracking - your conversations stay private, not stored anywhere
  • Offline-first design - works without internet (except for AI API calls)

๐Ÿ–ฅ๏ธ Always-On, One Click Away

Pluely sits quietly on your desktop, ready to assist instantly with zero setup time:

๐ŸŽฏ Perfect for Sensitive Scenarios

Completely undetectable in all these critical situations:

  • Job interviews - Get real-time answers without anyone knowing you're using AI
  • Sales calls - Access product information instantly while maintaining professionalism
  • Technical meetings - Quick reference to documentation without breaking flow
  • Educational presentations - Learning assistance that's invisible to your audience
  • Client consultations - Professional knowledge at your fingertips, completely discrete
  • Live coding sessions - Get syntax help, debug errors, explain algorithms without detection
  • Design reviews - Analyze screenshots, get UI/UX suggestions invisibly
  • Writing assistance - Grammar check, tone adjustment, content optimization in stealth mode
  • Board meetings - Access information without anyone noticing
  • Negotiations - Real-time strategy assistance that remains completely hidden

and many more use cases...


๐Ÿš€ Features

๐Ÿค– Multi-LLM Support

Connect to any AI provider with built-in support for:

  • OpenAI - Dynamically fetches models directly from OpenAI, select your own
  • Anthropic Claude - Enter your model name manually
  • xAI Grok - Dynamically fetches models directly from xAI, select your own
  • Google Gemini - Dynamically fetches models directly from Gemini, select your own
  • Custom providers - Coming soon

๐ŸŽค Advanced Speech-to-Text

Pluely offers two powerful audio input methods:

๐ŸŽค Default Input (Microphone)

  • Voice Activity Detection (VAD) using @ricky0123/vad-react
  • Real-time voice commands - just speak and get AI responses
  • Works immediately - no setup required on any platform

๐Ÿ”Š System Audio Capture (Everything Your Computer Plays)

  • Meeting transcription - capture Zoom, Teams, Google Meet audio
  • Video analysis - transcribe YouTube, educational content, podcasts
  • Real-time processing with automatic speech detection
  • Cross-platform support - works on macOS, Windows, Linux
  • Setup required - see System Audio Setup Guide

With any industry-leading STT providers: OpenAI Whisper, Groq, ElevenLabs, Google, Deepgram, and more!

๐Ÿ“Ž Multi-Modal Input

  • Text input with markdown support
  • Image attachments - analyze images, screenshots

๐ŸŽจ Beautiful, Invisible UI

  • Translucent window that overlays any application
  • Always on top but never in the way
  • Minimal design - focus on content, not interface
  • Dark/light theme support

๐Ÿ‘ป Advanced Stealth Features

  • App Icon Stealth Mode - Complete dock/taskbar invisibility for maximum discretion
  • Intelligent Icon Management - Automatically hide/show based on window visibility settings
  • Cross-Platform Stealth - Works seamlessly on macOS (Dock), Windows (Taskbar), and Linux (Panel)
  • Global Keyboard Shortcuts - Control app from anywhere without detection

โšก Real-Time Streaming

  • Chunked streaming - see responses as they're generated
  • Cancellable requests - stop generation anytime
  • Error handling with retry mechanisms

๐ŸŒ Cross-Platform Compatibility

Pluely works seamlessly across all major operating systems with comprehensive audio capture support.

๐ŸŽฏ Audio Capture Methods

Pluely offers multiple audio capture options to work with any setup:

๐ŸŽค Default Input Capture (Works Immediately)

  • โœ… No setup required - works out of the box on all platforms
  • โœ… Uses your microphone for voice input and commands
  • โœ… Perfect for: Voice dictation, personal notes, voice commands
  • โœ… Supported: macOS, Windows, Linux

๐Ÿ”Š System Audio Capture (Advanced Setup)

  • ๐ŸŽฏ Captures everything your computer plays - meetings, videos, music
  • ๐ŸŽฏ Perfect for: Meeting transcription, video analysis, system audio monitoring
  • โš™๏ธ Requires: Virtual audio device setup (platform-specific)
  • โœ… Supported: macOS, Windows, Linux

๐Ÿ–ฅ๏ธ Platform Support Matrix

Platform Default Input System Audio Virtual Audio Solutions
๐ŸŽ macOS โœ… Built-in โœ… Supported BlackHole (free), Loopback ($109), SoundFlower
๐ŸชŸ Windows โœ… Built-in โœ… Supported Stereo Mix (built-in), VB-Audio Cable (free), VoiceMeeter (free)
๐Ÿง Linux โœ… Built-in โœ… Supported PulseAudio Monitors (built-in), ALSA Loopback

๐ŸŽต System Audio Capture Capabilities

Once configured, system audio capture enables transcription of:

  • ๐ŸŽฅ Meeting Audio: Zoom, Teams, Google Meet, Discord, Slack
  • ๐ŸŽฌ Video Content: YouTube, Netflix, Twitch, educational videos
  • ๐ŸŽต Music & Podcasts: Spotify, Apple Music, podcast apps
  • ๐ŸŽฎ Game Audio: Game commentary, streaming content
  • ๐Ÿ“ž VoIP Calls: Skype, WhatsApp calls, phone calls
  • ๐Ÿ“ฑ Any System Audio: Everything your computer plays

๐Ÿ› ๏ธ Setup Difficulty by Platform

๐ŸŽ macOS Setup

  • Default Input: โœ… Instant - no setup required
  • System Audio: โš™๏ธ Easy - install BlackHole, configure Multi-Output
  • Time: ~5 minutes for system audio setup
  • Best Option: BlackHole (free) or Loopback (paid but easier)

๐ŸชŸ Windows Setup

  • Default Input: โœ… Instant - no setup required
  • System Audio: โš™๏ธ Easy - enable Stereo Mix or install VB-Cable
  • Time: ~3 minutes for system audio setup
  • Best Option: Stereo Mix (built-in) or VB-Audio Cable (free)

๐Ÿง Linux Setup

  • Default Input: โœ… Instant - no setup required
  • System Audio: โš™๏ธ Easy - PulseAudio monitors usually work out-of-box
  • Time: ~2 minutes for system audio setup
  • Best Option: PulseAudio Monitor devices (usually pre-configured)

๐Ÿ”ง Built-in Debug & Testing Tools

Pluely includes comprehensive debugging tools for all platforms:

  • ๐Ÿ” Device Debug: Shows all available audio devices with detailed analysis
  • ๐ŸŽต Audio Level Testing: 3-second audio level test with real-time feedback
  • ๐Ÿ“Š Real-time Monitoring: Live RMS/Peak audio level display in console
  • ๐ŸŽฏ Smart Device Detection: Automatically selects best available device
  • ๐Ÿ”„ Auto-Recovery: Handles device conflicts and "already running" errors

๐Ÿ“š Comprehensive Documentation

  • ๐Ÿ“– SYSTEM_AUDIO_SETUP.md: Complete setup guide for all platforms
  • ๐ŸŽฏ Platform-specific instructions: Step-by-step guides with screenshots
  • ๐Ÿ”ง Troubleshooting: Common issues and solutions for each OS
  • ๐Ÿ’ก Pro Tips: Best practices and optimization recommendations

๐Ÿš€ Quick Start (Any Platform)

  1. Download Pluely for your platform from releases
  2. Install & Launch the application
  3. Click the audio button (headphones icon) in the interface
  4. Choose your method:
    • "๐ŸŽค Default Input" - works immediately, no setup
    • "๐Ÿ”„ System Audio" - requires virtual audio setup (see guide)
  5. Start speaking or play audio - transcription begins automatically!

๐ŸŽ‰ Why Cross-Platform Matters

  • ๐ŸŒ Universal Access: Use Pluely on any device, anywhere
  • ๐Ÿ”„ Consistent Experience: Same features and UI across all platforms
  • ๐Ÿ› ๏ธ Flexible Setup: Multiple audio solutions to fit any environment
  • ๐Ÿ“ˆ Future-Proof: Built with Tauri for native performance on all platforms

๐Ÿ› ๏ธ Installation & Setup

Prerequisites

  • Node.js (v18 or higher)
  • Rust (latest stable)
  • npm or yarn

๐ŸŽต Audio Capabilities: The built app includes full cross-platform audio support with both microphone input and system audio capture. See SYSTEM_AUDIO_SETUP.md for platform-specific setup guides.

Quick Start

# Clone the repository
git clone https://github.com/iamsrikanthnani/pluely.git
cd pluely

# Install dependencies
npm install

# Start development server
npm run tauri dev

Build for Production

# Build the application
npm run tauri build

This creates platform-specific installers in src-tauri/target/release/bundle/:

  • macOS: .dmg file
  • Windows: .msi installer
  • Linux: .deb file

๐Ÿ” Security & Privacy

Local API Key Storage

  • API keys are stored in browser localStorage (not sent to any server)
  • No telemetry - your keys never leave your device
  • Session-based - keys can be cleared anytime

Secure API Communication

  • Direct HTTPS connections to AI providers
  • No proxy servers - your requests go straight to the AI service
  • Request signing handled locally
  • TLS encryption for all API communications

Data Handling

  • No conversation logging - messages aren't stored anywhere
  • Temporary session data - cleared on app restart
  • Local file processing - images processed in-browser
  • No analytics - completely private usage

Why Frontend API Calls Are Better

Pluely makes API calls directly from your frontend because:

  1. ๐Ÿ”’ Maximum Privacy: Your conversations never touch our servers
  2. ๐Ÿš€ Better Performance: Direct connection = faster responses
  3. ๐Ÿ“ฑ Always Local: Your data stays on your device, always
  4. ๐Ÿ” Transparent: You can inspect every network request in dev tools
  5. โšก No Bottlenecks: No server capacity limits or downtime

๐Ÿš€ Performance Optimizations

Tauri Advantages

  • Native binary - no JavaScript runtime overhead
  • Rust backend - memory-safe, ultra-fast
  • Small bundle size - ~10MB total app size
  • Instant startup - launches in <100ms
  • Low memory usage - typically <50MB RAM

Frontend Optimizations

  • React 18 with concurrent features
  • TypeScript for compile-time optimization
  • Vite for lightning-fast development
  • Tree shaking - only bundle used code
  • Lazy loading - components load on demand

๐Ÿงช Development

๐Ÿ—๏ธ Architecture Overview

Frontend (React + TypeScript + Tauri)

src/
โ”œโ”€โ”€ components/           # Reusable UI components
โ”‚   โ”œโ”€โ”€ completion/      # AI completion interface
โ”‚   โ”‚   โ”œโ”€โ”€ Audio.tsx    # Audio recording component
โ”‚   โ”‚   โ”œโ”€โ”€ AutoSpeechVad.tsx # Voice activity detection
โ”‚   โ”‚   โ”œโ”€โ”€ Files.tsx    # File handling component
โ”‚   โ”‚   โ”œโ”€โ”€ index.tsx    # Main completion component
โ”‚   โ”‚   โ””โ”€โ”€ Input.tsx    # Text input component
โ”‚   โ”œโ”€โ”€ Header/          # Application header
โ”‚   โ”œโ”€โ”€ history/         # Chat history components
โ”‚   โ”‚   โ”œโ”€โ”€ ChatHistory.tsx # Chat history management
โ”‚   โ”‚   โ”œโ”€โ”€ index.tsx    # History exports
โ”‚   โ”‚   โ””โ”€โ”€ MessageHistory.tsx # Message history display
โ”‚   โ”œโ”€โ”€ Markdown/        # Markdown rendering
โ”‚   โ”œโ”€โ”€ Selection/       # Text selection handling
โ”‚   โ”œโ”€โ”€ settings/        # Configuration components
โ”‚   โ”‚   โ”œโ”€โ”€ ai-configs/  # AI provider configurations
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ CreateEditProvider.tsx # Custom AI provider setup
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ CustomProvider.tsx # Custom provider component
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.tsx # AI configs exports
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Providers.tsx # AI providers list
โ”‚   โ”‚   โ”œโ”€โ”€ DeleteChats.tsx # Chat deletion functionality
โ”‚   โ”‚   โ”œโ”€โ”€ Disclaimer.tsx # Legal disclaimers
โ”‚   โ”‚   โ”œโ”€โ”€ index.tsx    # Settings panel
โ”‚   โ”‚   โ”œโ”€โ”€ ScreenshotConfigs.tsx # Screenshot configuration
โ”‚   โ”‚   โ”œโ”€โ”€ stt-configs/ # Speech-to-text configurations
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ CreateEditProvider.tsx # Custom STT provider setup
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ CustomProvider.tsx # Custom STT provider
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ index.tsx # STT configs exports
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ Providers.tsx # STT providers list
โ”‚   โ”‚   โ””โ”€โ”€ SystemPrompt.tsx # Custom system prompt editor
โ”‚   โ”œโ”€โ”€ TextInput/       # Text input components
โ”‚   โ”œโ”€โ”€ ui/              # shadcn/ui component library
โ”‚   โ””โ”€โ”€ updater/         # Application update handling
โ”œโ”€โ”€ config/              # Application configuration
โ”‚   โ”œโ”€โ”€ ai-providers.constants.ts # AI provider configurations
โ”‚   โ”œโ”€โ”€ constants.ts     # General constants
โ”‚   โ”œโ”€โ”€ index.ts         # Config exports
โ”‚   โ””โ”€โ”€ stt.constants.ts # Speech-to-text provider configs
โ”œโ”€โ”€ contexts/            # React contexts
โ”‚   โ”œโ”€โ”€ app.context.tsx  # Main application context
โ”‚   โ”œโ”€โ”€ index.ts         # Context exports
โ”‚   โ””โ”€โ”€ theme.context.tsx # Theme management context
โ”œโ”€โ”€ hooks/               # Custom React hooks
โ”‚   โ”œโ”€โ”€ index.ts         # Hook exports
โ”‚   โ”œโ”€โ”€ useCompletion.ts # AI completion hook
โ”‚   โ”œโ”€โ”€ useCustomProvider.ts # Custom provider hook
โ”‚   โ”œโ”€โ”€ useCustomSttProviders.ts # Custom STT providers hook
โ”‚   โ”œโ”€โ”€ useSettings.ts   # Settings management hook
โ”‚   โ”œโ”€โ”€ useVersion.ts    # Version management hook
โ”‚   โ””โ”€โ”€ useWindow.ts     # Window management hook
โ”œโ”€โ”€ lib/                 # Core utilities
โ”‚   โ”œโ”€โ”€ chat-history.ts  # Chat history management
โ”‚   โ”œโ”€โ”€ functions/       # Core functionality modules
โ”‚   โ”‚   โ”œโ”€โ”€ ai-models.function.ts # AI model handling
โ”‚   โ”‚   โ”œโ”€โ”€ ai-response.function.ts # AI response processing
โ”‚   โ”‚   โ”œโ”€โ”€ common.function.ts # Common utilities
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts     # Function exports
โ”‚   โ”‚   โ””โ”€โ”€ stt.function.ts # Speech-to-text functions
โ”‚   โ”œโ”€โ”€ storage/         # Local storage management
โ”‚   โ”‚   โ”œโ”€โ”€ ai-providers.ts # AI provider storage
โ”‚   โ”‚   โ”œโ”€โ”€ helper.ts    # Storage helpers
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts     # Storage exports
โ”‚   โ”‚   โ””โ”€โ”€ stt-providers.ts # STT provider storage
โ”‚   โ”œโ”€โ”€ index.ts         # Lib exports
โ”‚   โ”œโ”€โ”€ utils.ts         # Utility functions
โ”‚   โ””โ”€โ”€ version.ts       # Version utilities
โ”œโ”€โ”€ types/               # TypeScript type definitions
โ”‚   โ”œโ”€โ”€ ai-provider.type.ts # AI provider types
โ”‚   โ”œโ”€โ”€ completion.hook.ts # Completion hook types
โ”‚   โ”œโ”€โ”€ completion.ts    # Completion types
โ”‚   โ”œโ”€โ”€ context.type.ts  # Context types
โ”‚   โ”œโ”€โ”€ index.ts         # Type exports
โ”‚   โ”œโ”€โ”€ settings.hook.ts # Settings hook types
โ”‚   โ”œโ”€โ”€ settings.ts      # Settings types
โ”‚   โ””โ”€โ”€ stt.types.ts     # Speech-to-text types
โ”œโ”€โ”€ App.tsx              # Main application component
โ”œโ”€โ”€ main.tsx             # Application entry point
โ”œโ”€โ”€ global.css           # Global styles
โ””โ”€โ”€ vite-env.d.ts        # Vite environment types

Backend (Tauri + Rust)

src-tauri/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ main.rs          # Application entry point
โ”‚   โ”œโ”€โ”€ lib.rs           # Core Tauri setup and IPC handlers
โ”‚   โ””โ”€โ”€ window.rs        # Window management & positioning
โ”œโ”€โ”€ build.rs             # Build script for additional resources
โ”œโ”€โ”€ Cargo.toml           # Rust dependencies and build configuration
โ”œโ”€โ”€ tauri.conf.json      # Tauri configuration (windows, bundles, etc.)
โ”œโ”€โ”€ Cargo.lock           # Dependency lock file
โ”œโ”€โ”€ capabilities/        # Permission configurations
โ”‚   โ””โ”€โ”€ default.json     # Default capabilities
โ”œโ”€โ”€ gen/                 # Generated files
โ”œโ”€โ”€ icons/               # Application icons (PNG, ICNS, ICO)
โ”œโ”€โ”€ info.plist           # macOS application info
โ”œโ”€โ”€ pluely.desktop       # Linux desktop file
โ””โ”€โ”€ target/              # Build output directory

Development Commands

# Start Tauri development
npm run tauri dev

# Build for production
npm run build
npm run tauri build

# Type checking
npm run type-check

# Linting
npm run lint

๐Ÿค Contributing

We welcome contributions! Here's how to get started:

๐Ÿ’ก Like this project? Consider buying me a coffee โ˜• or hiring me for your next project!

Development Setup

# Fork and clone the repository
git clone https://github.com/iamsrikanthnani/pluely.git
cd pluely

# Install dependencies
npm install

# Start development
npm run tauri dev

Contributing Guidelines

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Code Style

  • TypeScript for type safety
  • ESLint + Prettier for formatting
  • Conventional Commits for commit messages
  • Component documentation with JSDoc

๐Ÿ“„ License

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


๐Ÿ™ Acknowledgments


๐Ÿ”— Links


๐ŸŒ Let's Connect

GitHubย  Twitterย  Websiteย  LinkedInย  License


Made with โค๏ธ by Srikanth Nani

Experience the power of Cluely, but with complete transparency and control over your data.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for pluely

Similar Open Source Tools

For similar tasks

For similar jobs