diff --git a/README.md b/README.md index fef1ac9..56585b4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@
- Open-source AI-powered LaTeX writing workspace with live preview.
+ A private, offline-first LaTeX workspace powered by Claude.
+ Your documents never leave your machine.
@@ -16,18 +17,65 @@ --- +## Why ClaudePrism? + +[OpenAI Prism](https://openai.com/prism/) is a cloud-based LaTeX workspace for scientists — free, powerful, but **your unpublished research lives on OpenAI's servers**. Experts have [raised concerns](https://decrypt.co/356259/openai-science-platform-prism-experts-warn-privacy-concerns) about intellectual property exposure and whether OpenAI could claim rights over researcher data. By default, content may be used to train future models unless you opt out. + +ClaudePrism takes a different approach: **everything runs locally on your machine.** + +| | OpenAI Prism | ClaudePrism | +|---|:---:|:---:| +| AI Model | GPT-5.2 (cloud) | **Claude Opus / Sonnet / Haiku (local CLI)** | +| Runtime | Browser (cloud) | **Native desktop (Tauri 2 + Rust)** | +| LaTeX | Cloud compilation | **Tectonic (embedded, offline)** | +| PDF | Cloud rendering | **MuPDF (native, SyncTeX)** | +| Getting Started | Account setup required | **Install and go — template gallery + project wizard** | +| Version Control | — | **Git-based history with labels & diff** | +| Data Privacy | Cloud storage, may train models | **Zero data collection, fully local** | +| Offline | Requires internet | **Fully offline after first compile** | +| Source Code | Proprietary | **Open source (MIT)** | + +### Your Research, Your Machine + +ClaudePrism invokes the **Claude CLI** as a local subprocess — your prompts and documents are handled on your machine, not routed through any intermediary server. There is **no telemetry, no analytics, no cloud logging** in the app. + +- Claude Code (the CLI) [does not train on your data](https://docs.anthropic.com/en/docs/claude-cli) +- Your unpublished papers, embargoed findings, and IP stay on your local disk +- No account data, no usage tracking, no "outcome-based pricing" on your discoveries +- Open source — audit the code yourself + +--- + ## Features -- **Claude AI Assistant** — Chat with Claude directly in the editor. Supports Sonnet, Opus, Haiku models with adjustable reasoning effort. Slash commands, tool use, and session persistence. -- **LaTeX Editor** — CodeMirror 6 with LaTeX/BibTeX syntax highlighting, real-time linting, find & replace, and multi-file project support. -- **Live PDF Preview** — Native MuPDF rendering with SyncTeX (click PDF → jump to source), zoom, text selection, and annotation capture. -- **Tectonic Compilation** — Self-contained LaTeX compiler built in. No TeX Live installation required. +### Quick Start with Templates & Project Wizard +Pick a template (paper, thesis, presentation, poster, letter, etc.), give it a name, optionally describe what you're writing — ClaudePrism sets up the project and generates initial content with AI. Drag & drop reference files (PDF, BIB, images) and start writing immediately. + +### Claude AI Assistant +Chat with Claude directly in the editor. Select between Sonnet, Opus, Haiku models with adjustable reasoning effort levels. Persistent sessions, tool use (file edit, bash, search), and extensible slash commands. + +### Proposed Changes Review +When Claude suggests edits, changes appear in a dedicated panel with visual diffs. Accept or reject per chunk, or apply/undo all at once (`⌘Y` / `⌘N`). Your original content is always preserved until you decide. + +### Git-Based History +Every save creates a snapshot in a local Git repository (`.claudeprism/history.git/`). Label important checkpoints, browse diffs between any two snapshots, and restore previous versions — all without leaving the app. + +### Offline LaTeX Compilation +Tectonic is embedded directly in the app. Packages are downloaded once on first use and cached locally. After that, compilation works fully offline with no TeX Live installation required. + +### Live PDF Preview +Native MuPDF rendering with SyncTeX support — click a position in the PDF to jump to the corresponding source line. Supports zoom, text selection, and annotation capture. + +### Editor +CodeMirror 6 with LaTeX/BibTeX syntax highlighting, real-time error linting, find & replace (regex), and multi-file project support with auto-save. + +### More - **Zotero Integration** — OAuth-based bibliography management and citation insertion. -- **Proposed Changes** — AI-suggested edits with visual diff review (accept/reject per chunk). -- **Template Gallery** — Pre-built LaTeX templates to start projects quickly. -- **Project Management** — File browser, folder creation, file import, and auto-save. -- **External Editor Support** — Open projects in Cursor, VS Code, Zed, or Sublime Text. -- **Dark / Light Theme** — Automatic theme switching. +- **Slash Commands** — Built-in (`/review`, `/init`) + custom commands from `.claude/commands/`. +- **External Editors** — Open projects in Cursor, VS Code, Zed, or Sublime Text. +- **Dark / Light Theme** — Automatic switching. + +--- ## Installation @@ -49,7 +97,9 @@ Download the latest build from [GitHub Releases](https://github.com/delibae/clau | **Linux** (x64) | `.AppImage` | `chmod +x` and run | | **Linux** (x64) | `.deb` | `sudo dpkg -i claude-prism_*.deb` | -> Claude AI features require the [Claude CLI](https://docs.anthropic.com/en/docs/claude-cli) (`claude`) installed locally. +> Claude AI features require the [Claude CLI](https://docs.anthropic.com/en/docs/claude-cli) installed locally. + +--- ## Tech Stack