diff options
| -rw-r--r-- | README.md | 59 |
1 files changed, 56 insertions, 3 deletions
@@ -12,8 +12,10 @@ - **Real-time Overleaf sync** — WebSocket-based OT collaboration, live co-editing - **Bidirectional file sync** — edit `.tex` files on disk (e.g. with Claude Code in the integrated terminal) and changes sync to Overleaf automatically +- **Claude Code MCP integration** — built-in MCP server lets Claude Code read comments, compile, debug, and chat with collaborators - **Local LaTeX compilation** — compile PDFs locally with `latexmk`, no Overleaf compile limits -- **PDF viewer** — built-in viewer with SyncTeX forward/inverse search, pinch-to-zoom +- **PDF viewer** — built-in viewer with SyncTeX forward/inverse search, pinch-to-zoom, text search +- **Search** — in-file find/replace (Cmd+F), multi-file search (Cmd+Shift+F), PDF text search - **LaTeX autocomplete** — commands, environments, `\ref`, `\cite`, file paths - **Comments & review** — inline comment highlights with review panel - **Collaborator cursors** — see other editors' positions in real-time @@ -31,9 +33,60 @@ Download the latest `.dmg` from [Releases](https://github.com/YurenHao0426/latte - macOS (Apple Silicon) - [TeX Live](https://www.tug.org/texlive/) or [MacTeX](https://www.tug.org/mactex/) for local compilation -## Recommendation +## Claude Code Integration -Install [Claude Code](https://code.claude.com/docs/en/setup) for AI-assisted LaTeX writing. Run it in the integrated terminal and let it edit your `.tex` files directly — changes sync to Overleaf in real-time. +LatteX has built-in [Claude Code](https://docs.anthropic.com/en/docs/claude-code) integration via MCP (Model Context Protocol). When you open a project, LatteX automatically: + +1. Syncs all project files to a local temp directory +2. Writes a `.mcp.json` config that registers the LatteX MCP server +3. Writes `.claude/CLAUDE.md` with project context and tool documentation +4. Pre-approves all MCP tool permissions in `.claude/settings.json` + +### Usage + +1. Open a project in LatteX +2. Open the integrated terminal (Cmd+`) +3. Run `claude` — Claude Code auto-discovers the MCP server and has full access to the project + +Claude Code can then: +- **Edit `.tex` files** directly on disk — changes sync to Overleaf in real-time via bidirectional file sync +- **Read and respond to comments** — `get_comments`, `reply_to_comment`, `resolve_comment` +- **Compile and debug** — `compile_latex`, `get_compile_errors`, `get_compile_warnings` +- **Use project chat** — `get_chat_messages`, `send_chat_message` +- **List project files** — `list_project_files` + +### Available MCP Tools + +| Tool | Description | +|------|-------------| +| `get_comments` | Read comments, optionally filtered by file | +| `resolve_comment` | Resolve a comment thread | +| `reopen_comment` | Reopen a resolved comment | +| `reply_to_comment` | Reply to a comment thread | +| `delete_comment` | Permanently delete a comment thread | +| `get_chat_messages` | Read project chat history | +| `send_chat_message` | Send a message to project chat | +| `list_project_files` | List all project files with sizes | +| `compile_latex` | Trigger server-side LaTeX compilation | +| `get_compile_errors` | Get parsed errors from last compile | +| `get_compile_warnings` | Get parsed warnings from last compile | +| `get_compile_log` | Get raw compile log output | + +### Example Workflow + +``` +> claude + +You: Review the comments on this paper and address the feedback + +Claude: [calls get_comments] I see 3 comments... + [edits sections/intro.tex to address feedback] + [calls reply_to_comment] "Revised the introduction as suggested." + [calls resolve_comment] + [calls compile_latex] Compilation successful, no errors. +``` + +No configuration needed — everything is set up automatically when you open a project. ## Development |