Skip to content

README.md

Latest commit

 

History

History
117 lines (81 loc) · 3.76 KB

README.md

File metadata and controls

117 lines (81 loc) · 3.76 KB

Jules for macOS

A native macOS menu bar application for interacting with the Jules AI coding assistant API.

jules-desktop

Features

  • Menu Bar Integration: Quick access from your menu bar or centered floating panel
  • Session Management: Create, view, and manage coding sessions
  • Real-time Updates: Live polling for session status and activity updates
  • Diff Viewing: High-performance Metal-accelerated diff visualization
  • Merge Conflict Resolution: Visual merge conflict handling
  • Offline Support: Queue sessions when offline, sync when connectivity returns
  • Keyboard Shortcuts: Global hotkeys for quick access
  • Auto-updates: Built-in update mechanism via Sparkle

Requirements

  • macOS 13.0 or later
  • Xcode 15.0 or later (for building)
  • A Jules API key (obtain from jules.google.com)

Building

  1. Clone the repository:

    git clone https://github.com/simpsoka/jules-osx.git
cd jules-osx

  2. Open the project in Xcode:

    open jules.xcodeproj

  3. Build and run (Cmd+R)

Configuration

API Key

Enter your Jules API key in the app's Settings to start using the application.

Firebase/Gemini (Optional)

The app includes optional Firebase integration for AI-generated activity descriptions using Gemini. This feature is disabled by default and the app works perfectly without it.

To enable Firebase/Gemini:

  1. Create a Firebase project at console.firebase.google.com
  2. Add a macOS app with your bundle ID
  3. Download GoogleService-Info.plist and replace the placeholder file in jules/
  4. Open jules/AppDelegate.swift and set: 
    let ENABLE_FIREBASE = true

Auto-Updates (Optional)

To enable auto-updates for your distribution:

  1. Set up a Sparkle appcast feed
  2. Update SPARKLE_APPCAST_URL in AppDelegate.swift
  3. Configure your signing keys in the project settings

Project Structure

jules/
├── AppDelegate.swift       # App lifecycle, menu bar, hotkeys
├── DataManager.swift       # Core data management and API coordination
├── APIService.swift        # REST API client for Jules backend
├── SessionRepository.swift # Session persistence (GRDB/SQLite)
├── Flux/                   # Metal-based diff rendering
├── MergeConflictWindow/    # Merge conflict UI
├── Canvas/                 # Drawing/annotation features
└── ...

Keyboard Shortcuts

Default shortcuts (configurable in Settings):

  • Control+Option+J: Toggle Jules menu
  • Control+Option+S: Capture screenshot
  • Control+Option+V: Voice input (macOS 26.0+)

Architecture

  • UI Framework: SwiftUI with AppKit integration
  • Database: SQLite via GRDB
  • Networking: URLSession with offline queue support
  • Graphics: Metal for high-performance diff rendering
  • Updates: Sparkle framework

Dependencies

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

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

Trademarks

"Jules" name, logo, and branding are trademarks of Alphabet Inc. and are used with permission.