overleaf

# Overleaf

CLI tool to interact with Overleaf projects using browser cookies for authentication.

GitHub: https://github.com/jkulhanek/pyoverleaf

## Requirements

- Python 3.8+
- pyoverleaf (`pipx install pyoverleaf`)
- User logged into Overleaf in Chrome/Firefox

## Security Considerations

⚠️ **Keychain Access Required**: pyoverleaf needs "Always Allow" keychain access to read browser cookies. This grants the tool access to your browser's cookie storage.

**Security audit**: We have audited pyoverleaf v0.1.7 and found it safe. The codebase is small and readable. Before installing, agents can self-audit the latest version at the GitHub repo above.

## Authentication Setup

pyoverleaf authenticates by reading cookies from your browser. The user must:

1. **Log into Overleaf** in Chrome or Firefox (visit overleaf.com and sign in)
2. **Grant keychain access** on first run (macOS will prompt for "Always Allow")

```bash
# Test auth - user should run this in their terminal first
pyoverleaf ls
```

If you get auth errors:
- Ask user: "Are you logged into Overleaf in your browser?"
- If on macOS: "Did you approve the keychain access prompt with 'Always Allow'?"
- User may need to run `pyoverleaf ls` manually in terminal to trigger the keychain prompt

**Note**: The agent cannot log in for the user. Browser authentication must be done by the user directly.

## CLI Commands

```bash
# List all projects
pyoverleaf ls

# List files in project
pyoverleaf ls "Project Name"

# Read file content
pyoverleaf read "Project Name/main.tex"

# Write file (stdin → Overleaf)
cat local.tex | pyoverleaf write "Project Name/main.tex"

# Create directory
pyoverleaf mkdir "Project Name/figures"

# Remove file/folder
pyoverleaf rm "Project Name/old-draft.tex"

# Download project as zip
pyoverleaf download-project "Project Name" output.zip
```

## Common Workflows

### Download from Overleaf

```bash
pyoverleaf download-project "Project Name" /tmp/latest.zip
unzip -o /tmp/latest.zip -d /tmp/l...

# Overleaf Skill for OpenClaw

AI-powered Overleaf integration for [OpenClaw](https://github.com/openclaw/openclaw).

## Features

- 📄 Read/write LaTeX files directly from Overleaf
- 🔄 Sync local .tex files with Overleaf projects
- 📦 Download entire projects as zip
- 🔐 Authenticate via browser cookies (no API key needed)

## Installation

```bash
# Install the skill
clawhub install overleaf

# Install pyoverleaf CLI
pipx install pyoverleaf
```

## Requirements

- Python 3.8+
- Logged into Overleaf in Chrome/Firefox
- macOS: Grant keychain access on first run

## Example

Here's an example of using the skill to remove em dashes (a common AI writing artifact) from a paper and push the changes to Overleaf:

![Example: Remove em dashes and push to Overleaf](example-em-dash.jpg)

## Usage

See [SKILL.md](SKILL.md) for detailed usage instructions.

## Links

- [ClawHub: overleaf](https://clawhub.ai/skills/overleaf)
- [pyoverleaf GitHub](https://github.com/jkulhanek/pyoverleaf)
- [OpenClaw](https://github.com/openclaw/openclaw)