Folio is an open-source terminal for Windows and macOS. It typesets LaTeX where a command prints it, previews files beside the prompt, lets panes and windows move freely, and marks the tab of an agent that is waiting for you.

中文说明 · Shortcuts · Security · Changes

Windows — take the zip from the releases page, unpack it, and run folio.exe. No installer; the files in it belong together, so keep the folder as it came. Windows 10 1809 or newer, 64-bit.

macOS — take the DMG from the releases page and drag Folio to Applications. Needs an Apple silicon Mac running macOS 14 or newer. Or, with Homebrew:

brew install --cask lulu-loopp/folio/folio

On Windows, winget has it too:

winget install --id WeiyiShi.Folio --exact

docs/install.md has the rest: what is in the archive, what the first run asks, and what to do if the system puts a panel in front of you.

Take Folio out the way it came in:

• Windows zip — open Settings ▸ About ▸ Uninstall Folio, or quit Folio and double-click uninstall.cmd in its folder.
• scoop — quit Folio, then scoop uninstall folio; it runs the same cleanup for you.
• winget — quit Folio, then cmd /c "folio --uninstall-cleanup && winget uninstall --id WeiyiShi.Folio --exact": the cleanup first, winget only once it succeeded, since winget runs nothing of Folio's. Settings ▸ About shows this line for a winget copy.
• macOS DMG — open Settings ▸ About ▸ Uninstall Folio, or quit Folio and run /Applications/Folio.app/Contents/MacOS/folio --uninstall. Either one removes Folio completely, the app included.
• Homebrew — quit Folio, then brew uninstall --zap folio.

Only the files Folio installed are removed, and its folder only if nothing else is left in it; a file of your own in the folder stays, and the uninstall names it.

If something Folio set up cannot be removed — a file another program holds, for example — the uninstall says which, keeps the program so you can run it again, and keeps your settings and data even if you asked for them to go. If the computer loses power while the files are being removed, run the uninstall again from the same folder: it removes what is left.

The uninstall removes what Folio set up outside its folder — the Explorer or Finder menu, the line it added to your PowerShell profile (with the profile file itself and the one copy it kept, when Folio made them), agent hooks — and keeps your settings and data. To remove those too, turn on Also remove settings and data in Settings, answer n in uninstall.cmd, or add --remove-data; Homebrew's --zap already removes the settings folder. Its lines are in the language Folio is set to. docs/install.md says what its exit codes mean.

The LaTeX a command prints is typeset where it was printed.

A file is read beside the prompt, and a markdown one typed into where you read it.

The agent waiting for you is marked on its tab.

• LaTeX in the terminal — $…$ and $$…$$ in command output, typeset in the line they were printed on.
• Preview beside the prompt — PDF page by page, video playing, a web page with an address field.
• Markdown you edit where you read it — in the reading typeface, saving every other byte of the file untouched.
• Panes, tabs and windows that move — split, tear off, float, and the sessions inside keep running.
• A terminal on a hotkey — Win+` , or ⌃` on a Mac, brings one down over whatever is on the screen.
• Search everything — actions, panes, commands, files and settings in one box.
• System integration — the Explorer and Finder right-click menus, and VS Code's external terminal.
• English and Chinese — every string in Folio's own interface in both, switched from one row in Settings.

Every feature is described in full, with the rules it follows, in docs/features.md.

Folio collects nothing: no telemetry, no analytics, no crash reporting. Two things reach the network — a page you open in the web preview, and the update check, one GET of https://api.github.com/repos/lulu-loopp/folio-terminal/releases carrying no version and no identifier — once a day on its own, which Settings > About > Automatic check (or "update_check": false) turns off, and once each time you press Check on the Version row. Settings, profiles and sessions live on your own machine and go nowhere; docs/PRIVACY.md says what is in each file.

Something broken goes in an issue. An idea, a feature you would like, or a question goes in Discussions, where the next person can find the answer.

MIT or Apache-2.0, at your option; THIRD-PARTY-NOTICES.md carries every dependency's and TRADEMARK.md the name and the marks.

docs/BUILDING.md builds it from source and points on to CONTRIBUTING.md and SECURITY.md.