Sidekick  by johnbean393

macOS app for local LLM chat using files, folders, and websites

created 9 months ago
3,000 stars

Top 16.3% on sourcepulse

GitHubView on GitHub
Project Summary

Sidekick is a native macOS application designed for local, private, and context-aware AI interactions. It empowers users to chat with local Large Language Models (LLMs) that can access and synthesize information from files, folders, and websites on their Mac, all offline. This tool is ideal for students, researchers, and professionals seeking to leverage AI for document analysis, research, and content creation without compromising data privacy or requiring external API keys.

How It Works

Sidekick utilizes Retrieval Augmented Generation (RAG) to process user queries against a configured set of "experts" (collections of files, folders, or websites). It leverages llama.cpp for efficient local LLM inference, particularly optimized for Apple Silicon. The application supports function calling for enhanced reasoning and task execution, memory for personalized interactions, and features like an inline writing assistant, AI content detection, diagram generation, and presentation creation. It also integrates CoreML for on-device image generation (requiring macOS 15.2+ and Apple Intelligence).

Quick Start & Requirements

  • Installation: Download and follow the setup guide.
  • Prerequisites: A Mac with Apple Silicon and a minimum of 8 GB RAM.
  • Resources: Access to files, folders, and websites can be configured via "experts."
  • Demo: View a demo of the inline writing assistant.

Highlighted Details

  • Local-First: Built-in inference engine for local models, with optional OpenAI-compatible API support.
  • RAG Integration: Enables querying extensive local data sources with efficient information retrieval.
  • Function Calling: Enhances LLM capabilities for tasks like string manipulation, arithmetic, and interacting with system applications (e.g., email drafts).
  • Advanced Features: Includes Canvas for text editing, image generation, LaTeX rendering, data visualization, and an inline writing assistant.

Maintenance & Community

The project is maintained by johnbean393. Contributions are welcome. Contact is available via email (johnbean393@gmail.com) or by filing an issue.

Licensing & Compatibility

The repository does not explicitly state a license in the provided README. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

Image generation requires macOS 15.2 or above and Apple Intelligence. The project's licensing status is unclear, which may impact commercial adoption. Developer setup requires specific signing identities and Xcode.

Health Check
Last commit

4 days ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
209 stars in the last 90 days

Explore Similar Projects

Starred by Addy Osmani Addy Osmani(Engineering Leader on Google Chrome), Victor Taelin Victor Taelin(Author of Bend, Kind, HVM), and
1 more.

chatbox by chatboxai

0.3%
36k
Desktop client app for AI models/LLMs
created 2 years ago
updated 5 days ago
Feedback? Help us improve.