Plue (under development)

A multi-agent coding assistant built with Swift and Zig

Plue is a native macOS application that provides an intelligent coding assistant interface with multiple interaction modes. It combines a modern Swift UI with high-performance Zig backend libraries to deliver a responsive and powerful development tool.

Note: This project currently only builds on macOS due to its native macOS UI components and frameworks.

Features

• 🎯 Vim-style Prompt Interface - Efficient text input with vim keybindings
• 💬 Modern Chat Interface - Conversational AI interaction
• 🖥️ Terminal Integration - Built-in terminal functionality
• 🌐 Farcaster Integration - Social coding features
• 🔧 Agent Workflows - Git worktree management and Dagger container integration
• ⚡ High Performance - Zig backend for optimal performance
• 📂 Command Line Interface - Open Plue from terminal like VSCode (plue /path/to/project)
• 🍎 Native macOS - Built specifically for macOS with native frameworks

Architecture

Plue uses a hybrid architecture:

• Swift Frontend - Native macOS UI using SwiftUI, providing smooth user experience
• Zig Backend - High-performance core libraries written in Zig for:
  • Business logic and state management
  • Farcaster protocol implementation
  • Core processing logic
• Unified Build System - Zig build system orchestrates both Zig and Swift compilation

Build System

Plue uses the Zig build system as the primary build orchestrator, which wraps and manages both:

• Zig library compilation
• Swift Package Manager (SPM) for the Swift application

The build process:

1. Stage 1: Build Zig libraries
2. Stage 2: Build Swift application using SPM, linking against Zig libraries

Requirements

• macOS 13.0+ (Ventura or later)
• Zig 0.14.1 (or later)
• Swift 5.8+ (included with Xcode)

Quick Start

1. Install Zig

Download and install Zig from https://ziglang.org/download/

macOS (using Homebrew):

brew install zig

2. Clone the Repository

git clone <repository-url>
cd plue

3. Build and Run

# Build the complete project
zig build

# Run the app
zig build run

# Or run the Swift executable directly
.build/release/plue

4. Install Command Line Interface (Optional)

Install the plue command globally for VSCode-like CLI usage:

# Install the CLI command globally
./scripts/install.sh

# Now you can use plue from anywhere
plue                       # Open in current directory  
plue ~/my-project         # Open in specific directory
plue .                    # Open in current directory (explicit)

Example CLI usage:

cd ~/code/my-awesome-project
plue                      # Opens Plue in this directory

# Or open directly in any project
plue ~/code/another-project

Development

Build Commands

# Build the complete project (Zig libraries + Swift application)
zig build

# Build and run the application
zig build run

# Run tests
zig build test

Build Commands

Command	Description
zig build	Build complete project (Zig + Swift)
zig build run	Build and run the application
zig build test	Run unit tests

Project Structure

plue/
├── Sources/plue/           # Swift application source
│   ├── App.swift          # Main application entry
│   ├── ContentView.swift  # Primary UI view
│   ├── VimPromptView.swift # Vim-style interface
│   ├── ModernChatView.swift # Chat interface  
│   ├── TerminalView.swift  # Terminal component
│   └── ...
├── src/                   # Zig backend libraries
│   ├── libplue.zig       # Core Swift interop library
│   ├── farcaster.zig     # Farcaster protocol implementation
│   └── ...
├── build.zig             # Zig build configuration
├── Package.swift         # Swift package configuration
└── .github/workflows/    # CI/CD configuration

Development Environment

Required tools:

• Xcode - For Swift compiler and macOS SDKs
• Zig - Zig compiler and build system (0.14.1 or later)
• macOS Frameworks - Foundation, AppKit, WebKit, Security (included with Xcode)

Building

Local Development

# Build complete project
zig build

# Run the application
zig build run

# Run tests
zig build test

Manual Build Steps (if needed)

If you need to build components separately:

# Build Zig libraries only
zig build-lib -dynamic -OReleaseFast src/libplue.zig -femit-bin=zig-out/lib/libplue.dylib

# Build Swift application
swift build --configuration release -Xlinker -Lzig-out/lib

Contributing

1. Clone the repository and ensure you have Zig and Xcode installed
2. Make your changes to Swift or Zig code
3. Test your changes: zig build test
4. Build and verify: zig build run
5. Submit a pull request

CI/CD

The project uses GitHub Actions for:

• Automated builds on every push and PR
• Test execution to ensure code quality
• Dependency updates via Dependabot

License

[Add your license here]

Support

[Add support information here]