GammaPDF
Documentation

Gamma user guide

Read papers, keep what you learn. This guide shows each part of Gamma in a short animation and a few lines. Installing it is in the README.

Section What it covers
Getting started Sign in, add a paper, read it
Highlight and annotate Highlights and their notes, area screenshots
Draw and type on the page Pens, the lasso, text boxes, pictures
Record audio A lecture in step with your notes; tap anything to hear that moment
Notebooks Sheets of paper to write on
Follow links and translate Citations, Back, translation in place
Notes Markdown and math that render as you type
Outline and links between pages Nesting, moving notes, [[ links, @ mentions and reminders
AI chat Ask about the paper, with clickable citations; every AI service you can connect
The library agent Let the AI organize and edit, with your approval; what each tool does
Library Labels or folders and how to file a paper, Recently deleted
Search Everything at once, Ctrl+P to jump
Metadata and citations Title, authors, BibTeX
Share a page Links for viewers and editors
Workspaces Personal and shared libraries, editing together
Comments and inbox Threads on notes, highlights and pages; mentions, replies and shares in one inbox
Offline copies A synced copy on your laptop or iPad
Zotero link A workspace in step with a Zotero library, both ways; what travels, PDFs, conflicts
Gamma Connector Save papers from the browser
Assistants Codex, Claude Code, DeepSeek Harness and other MCP clients; the tools they get
Import and export Zotero, Notability, Obsidian, Notion, PDF, BibTeX
Backups and upgrades Snapshots, exports, what a new version does
Install as an app iPad, phone, desktop
Settings Where things are
Shortcut cheat sheet Every default key

Getting started#

The plus button opens a dialog, an arXiv link is typed, a paper card appears in the library and the paper opens beside its notes; two files dragged into the window become cards too
  1. Sign in with the account your administrator gave you, or Continue as guest where the server allows it (a guest workspace is deleted after a while; the button says when).
  2. Add a paper: press + and paste any link (arXiv, DOI, a publisher page). Gamma finds the PDF. Or upload PDFs, or drag files and folders into the window.
  3. Read it. The paper opens with a Notes panel beside it. Select text to highlight, type under the highlight to add a note. Everything else builds on that.

A new account starts with a Welcome page to practise on, and a Sketchbook: a notebook whose drawings show what to try with the pen and circle where each button is. Tours in the account menu walk you through each part on the real controls.

Highlight and annotate#

One line of a paper is selected and turns yellow, appears as a block in the notes with a note typed under it; then a circle is drawn around a figure and becomes an ink block

Draw and type on the page#

The pen is picked from the tool strip, an arrow and a circle are drawn on the page, the lasso selects the arrow and recolors it red, and the strokes appear as one ink block in the notes

The pen button in the viewer's zoom column opens the tool strip: pens and highlighters, an eraser, a lasso, the Text tool, the Picture button, undo and redo.

The Text tool is picked, a click places a box on the page, a sentence is typed into it, and the box appears in the notes with a T marker

The Text tool puts typed text on the page like a text box in Acrobat: click to place, type, drag the handle to resize. Markdown and math work inside it, and each box is a note with a T marker.

The Picture button (I) on the strip puts photos and images on the page in view, a PDF page or a sheet of paper. A new picture lands in the middle of the page, at most half its width and height, and stays selected. Pictures lie under the handwriting and the text boxes, and each one is a note with a picture marker.

Record audio#

The microphone button starts a recording; a word is written and a note typed while it runs; after Stop, Play on the recording's card replays the audio with the handwriting and the note revealed as they were written, and a tap on the word jumps the audio back to that moment

Press the microphone in the viewer's zoom column (after the pen, unless you moved it) and keep reading and writing: everything you write or type while it records is linked to the moment you made it.

Try the interactive demo of playback.

Notebooks#

/note is typed in the notes, a ruled sheet appears, a pen writes on it, and a second sheet slides in below when the writing nears the bottom

A notebook is a page with sheets of paper to write on, and any page can hold them.

A citation in the paper is clicked, a popover offers Fetch into Gamma, the cited paper opens in a new tab, and Back returns to the first paper at the same spot The translate button is clicked and the paragraphs are redrawn in another language over the original while the figure stays; holding Alt peeks at the original

Notes#

A display equation is typed as LaTeX with a live preview and renders in place, a callout is typed as markdown and becomes a box, and a to-do line becomes a checkbox

Notes are a nested outline. Highlights and free notes are the same kind of block.

Shift+Enter starts a new note, Tab indents it under the one above, and dragging a note's handle moves it above another Two brackets are typed in a note, a picker lists pages, one becomes a chip in the line, and a Linked from row under the page lists the note

AI chat#

Ctrl+drag crops a figure into the chat, a question is typed and sent, the answer streams in with a p. 4 citation, and clicking it highlights the passage in the paper

Open the chat from the View menu (≡) → AI Chat. Gamma has no AI of its own: connect a service in Settings → AI → Connections and the chat uses your account with it. Keys stay on the server and are never sent back to the browser; a server administrator can also add connections everyone on the server shares.

AI services you can connect#

A connection is a sign-in or an API key plus the address the chat talks to. The dialog checks the key against the service's own model list, and you pick the models the chat offers from that list.

Service Sign-in Address
ChatGPT Your ChatGPT Plus or Pro subscription, signed in in the browser. No API key Fixed; nothing to enter
Anthropic (Claude) Console API key https://api.anthropic.com, or any service that speaks the Anthropic Messages API
OpenAI API (GPT) API key https://api.openai.com
DeepSeek API key https://api.deepseek.com
Kimi API key, or a Kimi Code subscription https://api.moonshot.ai; China https://api.moonshot.cn; Kimi Code https://api.kimi.com/coding/v1
Qwen API key, or a Coding Plan subscription Model Studio https://dashscope-intl.aliyuncs.com/compatible-mode/v1; China https://dashscope.aliyuncs.com/compatible-mode/v1; Coding Plan https://coding-intl.dashscope.aliyuncs.com/v1, China https://coding.dashscope.aliyuncs.com/v1
GLM API key, or a GLM Coding Plan subscription Z.ai https://api.z.ai/api/paas/v4; Zhipu China https://open.bigmodel.cn/api/paas/v4; Coding Plan …/api/coding/paas/v4 on either host
OpenRouter API key https://openrouter.ai/api/v1
Custom endpoint API key, if the server wants one Any OpenAI-compatible address: a gateway such as LiteLLM, or a local server such as Ollama, vLLM or llama.cpp

DeepSeek, Kimi, Qwen, GLM, OpenRouter and the custom endpoint sit under the Other tile. A coding-plan subscription is an API key the vendor's console makes for that plan, pointed at the plan's own address; Alibaba allows the Qwen Coding Plan only inside coding tools. There is no Anthropic subscription sign-in, since Anthropic's terms do not allow one: Claude is reached with a Console key.

The library agent#

In a folder chat, rename these AuthorYear is sent; a card shows the rename with the old title struck through; Allow once is clicked and the four cards are renamed, with an undo pill

On the home page or in a folder, the chat can act on your library: list, read and search the papers in view, rename them, file them into folders, rename folders, make and apply labels, delete a folder or a label (never its pages), search the web for papers and save them, build BibTeX, and edit your notes. On a paper, the same chat reads, searches and edits that paper and its notes.

What the chat's tools can do#

Permission Tools What they do
Read your library
List pages list_pages, list_folders, list_deleted Browse page titles, folders, metadata and Recently deleted; a long library in batches (folder chats)
Read pages read_page, read_chats, cite Read PDF text, highlights, notes, earlier chats and citation records (metadata, BibTeX)
Read note blocks read_block Read individual notes and their outline
View pages and handwriting view_pdf_page, view_ink, view_image Look at figures, tables, scanned pages, your handwriting and the pictures in your notes and on your pages
Search library search_library Find text in your notes and PDFs
Web research
Search papers online search_papers, related_papers, search_web Find papers on Crossref, arXiv and OpenAlex, follow their citations, and search the web through your AI connection, Brave Search or SearXNG (Tool usage → Online search)
Fetch documents fetch_paper, read_paper Read a DOI, arXiv id or URL without saving it; a paywall or sign-in hands the fetch to your browser
Use journal sign-ins Use the publisher sign-ins Gamma Connector saved when fetching
Make changes
Save papers save_paper Add a paper found online to the library
Rename pages rename_page Change pages' titles, many in one call (folder chats)
Move pages move_page File pages into a folder, many in one call (folder chats)
Restore deleted pages restore_page Bring pages back from Recently deleted (folder chats)
Organize folders and labels rename_folder, create_label, rename_label, label_page Rename folders, and make, rename and apply labels — to many pages in one call (folder chats)
Delete folders and labels delete_folder, delete_label Delete a folder or a label, never its pages; always asks, and you can revert it from the reply (folder chats)
Edit note blocks edit_block, create_block, move_block, delete_block, clip_region Create, edit, move and delete notes, transcribe handwriting, and clip a region of a PDF page into a note

The agent cannot delete pages: deleting a folder or a label leaves its pages in your library. An assistant connected from outside (Assistants) gets the reading tools only.

Library#

A paper card is dragged onto a folder, a label is typed into a card's label row and becomes a chip, and clicking the chip filters the grid

The home page lists your pages, most recent first, with a Recently viewed strip on top.

Labels or folders?#

Neither one copies a paper, and a paper can have as many labels and folders as you like. The difference is how you'll come back to it.

A label is a word you'll search for. A paper on PDH locking gets pdh. A paper from Vladan's lab on PGC cooling gets vladan and pgc. Labels are flat, so keep them short: a technique, an author, a lab, a keyword.

A folder is a label that nests. Use one for a topic you're studying or something you're preparing.

A simple test: if you'd type it into search, make it a label. If you'd open it and work through it, make it a folder.

Coming from Zotero? A folder is a collection (subfolders are subcollections) and a label is a tag. A Zotero import turns collections into folders and tags into labels, and a Zotero export turns them back; a Zotero link keeps the two in step. One difference: Zotero keeps an item in the parent collection when you add it to a subcollection, while Gamma moves it down into the subfolder.

Ctrl+F opens the search, a query is typed, results appear grouped as titles, this paper's notes and the text of every PDF, a folder chip narrows them, and the chosen paper opens at the match

Metadata and citations#

The info button opens the metadata: title, authors, year and DOI fill in; a BibTeX row's Copy button is clicked

Share a page#

The link button opens the share popover, Share makes the link, the general access toggle is flipped to Edit, and a second cursor labelled Maya starts typing in the notes

The link button in the top bar shares the open page.

Workspaces#

In a shared workspace two people type into two notes of the same page at the same time, each caret labelled with its writer's name, while a third reads along

A workspace is a separate library. The account menu lists yours and switches between them.

Comments and inbox#

Comments are a conversation about a note, a highlight or a page. They sit beside the notes and change none of them, and everyone who can open the page can read them.

The bell in the top bar is your Inbox (on a phone, More → Inbox). Its number counts what you have not read yet, across every workspace and share you can open.

Offline copies#

A note typed on a laptop syncs through the lab server to a phone; the laptop goes offline, a second note waits with a dot on the sync pill, and travels when the connection returns

Your library lives on your server. For the train or a lab without Wi-Fi, keep an offline copy: a workspace on a Gamma on your own laptop that holds a full copy and keeps the two in step.

A Zotero link keeps a workspace in step with a Zotero library through zotero.org, both ways: what you read, highlight and file in Gamma shows up in Zotero and on your other computers, and what you change in Zotero arrives here. Zotero stays the catalogue and Gamma becomes its PDF reader. Zotero itself need not be open, or even installed.

Connect your Zotero account#

Settings → Account & sync › Zotero; the link dialog offers the same buttons when no account is connected yet.

Settings → Workspaces › Clones and Zotero links → Link a Zotero library…

Directions and the sync pill#

What travels#

Gamma Zotero
Folders Collections Names, nesting and filing
Labels Tags Your own tags; automatic ones with Automatic tags as labels
A paper and its record An item and its fields Field by field
A page from a standalone PDF (a PDF and no record) That standalone PDF Gets a parent item once you save its record under the (i) button, or press Verify there
The paper's PDF The item's PDF The one Zotero's reader opens
A note from Zotero, as blocks in the notes That note Block by block
The paper's other notes One note, Notes from Gamma Sent once the page has been still for a minute
A note page from Zotero A standalone note Note pages made in Gamma stay in Gamma
Highlights, area highlights Highlights (an underline comes in as a highlight), image annotations Colour, place and text; a highlight's notes are its comment, bold and italic kept
Handwriting on a PDF page Ink annotations One per colour and width, without pressure or timing
Text boxes on a PDF page Text annotations (a sticky note comes in as a yellow box) The text, without Markdown
Recently deleted Zotero's trash Both ways

PDFs from Zotero#

Conflicts#

Limits#

Gamma Connector#

On a journal page the Gamma Connector badge lights up, its popup shows the paper with a folder and a label, Save to Gamma is clicked, and the card appears in that folder in Gamma

The browser extension saves the paper you are reading in one click: PDF, metadata, folder and labels. Add it from the Chrome Web Store (Chrome, Edge and other Chromium browsers), then click its toolbar button and enter your Gamma's address. Each release also carries it as a zip to load unpacked at chrome://extensions.

Assistants#

In a terminal an @Gamma question is typed, the assistant searches the library and reads the page, and answers with a page number while Gamma highlights the passage

Codex, Claude Code, DeepSeek Harness and any MCP client can search and read your papers, notes, highlights and PDF text, read-only, for one workspace you approve. Gamma runs an MCP server at <your Gamma>/mcp; the assistant connects to it and brings its own model. Gamma's own chat does not connect to outside MCP servers.

Connect an assistant#

Assistant How it connects
Codex CLI One setup command from the Codex CLI tab: it installs the Gamma plugin and opens the browser sign-in. By hand: codex mcp add gamma --url <your Gamma>/mcp, then codex mcp login gamma
Claude Code claude mcp add --transport http --scope user gamma <your Gamma>/mcp, then /mcp → gamma → sign in. The optional plugin from a release adds the /gamma:gamma workflow
DeepSeek Harness No browser sign-in: create a read-only token in its tab, run the install command once, then the start command, which asks for the token
Any other MCP client Add the MCP URL with the client's sign-in option (OAuth in the browser). A client without OAuth gets a token from Manual setup (advanced) and sends it as a bearer token

What an assistant can use#

Tool What it returns
list_folders The folder tree, each folder with its path and page counts
list_pages Pages with titles, folders, labels and metadata; filter by folder, label or title
search_library Full-text hits in notes and PDF text, with where each one is
read_page A page's notes, highlights, properties and PDF text in windows
read_block One note block or a page's note outline
read_chats The AI chat kept with a page or folder
view_pdf_page One PDF page as a picture: a scan, a figure, a table
view_ink Your handwriting as a picture
view_image The pictures a note embeds, or a picture placed on a page
cite The citation record kept with a page: metadata and BibTeX
read_gamma_link A pasted page, block or share link, read in place; a folder share lists its pages
export_page A page as Markdown, or as a PDF: the annotated paper or the notes typeset

The first ten are the chat's own reading tools. An assistant never gets the write tools or the web tools: the connection is read-only, and the assistant has web access of its own.

Import and export#

The View menu's Export dialog lists Annotated PDF, Notes as PDF, Markdown, BibTeX and Obsidian vault; a file flies out; arrows arrive from Zotero, Obsidian, Notion and PDF annotations

Both are in the View menu (≡), on a page or on the home library (with a folder open, Export takes the whole folder). To keep a Zotero library and Gamma in step instead of moving files between them, use a Zotero link.

Backups and upgrades#

Install as an app#

On a phone everything becomes full-screen views behind one bottom bar: Library, PDF, Notes, Chat, Add, Search, Share and More. On a desktop the Notes and Chat windows dock left, right or bottom by dragging their grip, and tabs sync to your account.

Settings#

Account menu → Settings, or Ctrl+,; the card with your name at the top of the account menu opens Account & sync. The search box at the top finds any setting by name. A red dot on the account button means something needs a look; the menu says what.

Pane What's there
Account & sync Your account, storage, the Gamma Cloud link, your Zotero account, settings sync
Appearance Theme, dark PDF pages, library cards, interface size, Inbox notifications, the top bar's buttons, the viewer's tools
Reading & editing Imported annotations, open-access fallback, how a new version of a PDF moves its highlights, handwriting, how search opens
Language and Translation Interface language, what translates and into what
Keyboard Every shortcut, rebindable; what Enter makes
AI → Connections, Chat, Tool usage, Integrations Providers and keys, defaults, agent permissions, assistants
Workspaces, Backups, Maintenance Workspaces, clones and Zotero links, snapshots, storage and index health
Users, Server (administrators) Accounts and invitations by e-mail, public URL, Gamma Cloud sign-in and requests to join, shared workspaces, server backups, the log
Help & diagnostics Session log, Report a problem… (adds what a maintainer needs, never your notes)

Top bar in Appearance hides a button you never use, or shows Background tasks and the Inbox only when they have news. A hidden button becomes a row of the account menu, and its shortcut still works. Viewer tools does the same for the column of buttons beside a PDF or a notebook: a hidden tool moves into the ⋯ at the column's end, and one you are using (a recording, a translation, the pen's strip, the text highlighter) stays on the column until you are done. In both lists, drag a row by its ⋮⋮ grip to change the order, or focus the grip and press ↑ / ↓; Reset puts the default order and buttons back. To get there from the bar itself, right-click (or long-press) an empty part of the top bar, or the viewer's column, and choose Customize top bar… or Customize viewer tools….

Invite by e-mail… in Users mails someone who has no account yet a link to make a free Gamma Cloud account, or sign in with theirs, and join this server. The Invitations list under the accounts sends one again or withdraws it.

Shortcut cheat sheet#

Ctrl+Shift+P runs any command by name. Settings → Keyboard changes any key, including the key held to box a region of the PDF and the key held to see a translation's original. On a Mac, Ctrl is ⌘ and Alt is ⌥.

Keys Does
Ctrl+F / Ctrl+Shift+F Search everything (on the home page: filter the listing / the full search)
Ctrl+P Quick open: a page, folder or label (Ctrl+Enter searches, Shift+Enter creates a page)
Ctrl+Shift+P Command palette
Ctrl+, Settings
F2 / Del Rename / delete the selected page
Ctrl+Z / Ctrl+Y (or Ctrl+Shift+Z) Undo / redo
Alt+← Back through link jumps
Enter / Shift+Enter Line break / new note (swappable); in search: next / previous match; in chat: send / newline; in a comment: newline / send
Tab / Shift+Tab Indent / outdent a note; accept a filter chip; hop {} arguments or table cells
↑ / ↓ On a note's first / last line: move into the note above / below
← / → At the text's edge: collapse / expand the note's children
Ctrl+Shift+K Delete the line (children stay)
Backspace On an empty note: delete it
Ctrl+B / Ctrl+I / Ctrl+U / Ctrl+E / Ctrl+Shift+X / Ctrl+Shift+H Bold / italic / underline / code / strike / highlight
Ctrl+K Link the selection (URL from the clipboard)
Ctrl+Shift+. Quote or unquote the selected lines
Ctrl+Shift+M Comment on the note being edited
Ctrl+C / Ctrl+X / Ctrl+V / Ctrl+D / Ctrl+A With the pen strip open: copy / cut / paste / duplicate the selected handwriting; select all handwriting on the page
1–9 · P / H · [ / ] · E · L · T · I · V · R · S · Z Pen strip: a preset by number · next pen / highlighter (Shift: previous) · thinner / thicker · eraser (hold it to erase once) · lasso · text · picture (the file picker) · hand · ruler · shapes · zoom window (Enter in it: a new line)
/ · [[ · @ Command menu (in a comment, the commands that write text) · page link · in a note or a comment, mention a date, person or page; in chat, attach a paper
Ctrl+wheel Zoom the PDF at the cursor
Ctrl+drag on the page Capture a region for the chat, and an optional area highlight
Hold Alt On a translated page: see the original
Ctrl+click a highlight Quote it into the chat
Ctrl+drag across note text Attach that passage to the chat
Double-click Open a library card; collapse a window (on its grip)
Right-click a tab Pin it, or pin its page to the library
Ctrl+Shift+S In the browser extension: save this page to Gamma
Esc Close popups, clear selections, cancel modes

Rendered from docs/user_guide/user_guide.md in the Gamma repository.