pi-design-deck  by nicobailon

Visual decision decks for AI agents

Created 2 months ago
264 stars

Top 96.6% on SourcePulse

GitHubView on GitHub
Project Summary

<2-3 sentences summarising what the project addresses and solves, the target audience, and the benefit.> This project provides a visual design deck tool for AI agents, enabling them to present multi-slide design options—such as code diffs, architecture diagrams, and UI mockups—to users. It targets users interacting with AI coding assistants, streamlining the decision-making process by offering high-fidelity visual previews for efficient selection and agent progression.

How It Works

The core mechanism involves an agent invoking a design_deck() tool, which spins up a local HTTP server. This server renders multi-slide visual decision decks, prioritizing a native WKWebView on macOS via Glimpse, falling back to a standard browser. Each slide presents 2-4 high-fidelity previews for user selection. The "Generate another option" feature leverages Server-Sent Events (SSE) for real-time updates, pushing new options into the live deck without requiring page reloads, maintaining state and user flow.

Quick Start & Requirements

  • Primary install: pi install npm:pi-design-deck (requires restarting pi agent).
  • Prerequisites: pi-agent v0.35.0 or later. Optional: pi install npm:glimpseui for native macOS windowing.
  • Provided Asset: A GitHub asset link is available: https://github.com/user-attachments/assets/aff1bac6-8bc2-461a-8828-f588ce655f7f.

Highlighted Details

  • Rich Preview Blocks: Supports four distinct block types—code with Prism.js syntax highlighting, mermaid for diagrams, html for custom snippets, and image referencing local files—which can be freely mixed within a single option.
  • Dynamic Option Generation: The "Generate another option" loop allows users to request additional design choices, which are seamlessly integrated into the active deck via SSE, enabling iterative refinement.
  • State Persistence & Export: Decks can be manually saved (Cmd+S) or auto-saved upon submission/cancellation, preserving selections and notes. Saved decks can be reopened or exported as standalone, read-only HTML files.
  • UX & Accessibility: Features include ARIA roles and keyboard navigation for option selection, light/dark/auto theme toggles, smart grid rebalancing for layout, and confirmation prompts for cancellations.

Maintenance & Community

No specific details regarding contributors, sponsorships, community channels (Discord/Slack), or roadmaps were found in the provided text.

Licensing & Compatibility

The license type and any specific compatibility notes for commercial use or closed-source linking are not explicitly stated in the provided README content.

Limitations & Caveats

Only one deck can be active at a time; decks must be completed or cancelled before starting a new one. Image blocks require absolute file paths on disk, not URLs. The summary slide ID is reserved. Mermaid diagrams require internet access for CDN loading. While tested primarily on macOS, Linux and Windows support is considered best-effort.

Health Check
Last Commit

3 weeks ago

Responsiveness

Inactive

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

Explore Similar Projects

Feedback? Help us improve.