Docs

Local Files

A Tranquil project is a folder on your own disk. Documents, data, bookmarks, and automations all sit in the file tree beside the web apps they relate to. Nothing is uploaded and there’s no account: files stay where you put them, and any tool that works on a folder works on this one.

Open a project

  • File → Open: open a folder as a project, in a new window.
  • Cmd-B: focus the file tree.

The tree’s tab-bar buttons create a new file or new folder, refresh the tree, and collapse all folders.

Organize the tree

  • Hover a file or folder for rename and delete buttons.
  • Drag onto a folder to move it. Hold ⌥ or ⌘ while dropping to copy it instead. Copies undo with Cmd-Z.

Each file type gets its own icon, so documents, data, and code are easy to tell apart at a glance.

What opens how

Tranquil is a code editor first, so most files open as text. A few open in a view of their own.

KindExamplesOpens as
Text and data.txt .csv .json .xmlText editor, highlighted where the format is recognized. CSV has no grid view.
Code.ts .pyText editor with syntax highlighting
Markdown.mdText editor. Toggle Markdown Preview (tab-bar button or command palette) swaps it for the rendered view in the same tab.
PDF.pdfPDF preview
Images.png .jpgImage preview
Bookmarks.urlA browser tab

Audio and video have no built-in player, so they open as unreadable binary.

Bookmarks are files

A bookmark is a small text file in your project, not an entry in a browser’s profile:

[InternetShortcut]
URL=https://example.com/

That’s the standard Internet Shortcut format: an INI-style text file with an [InternetShortcut] section and a URL= line. Because it’s a standard, the file works outside Tranquil too. Double-click one in Finder or File Explorer and it opens in your default browser.

So bookmarks belong to the project rather than to one browser. Organize them in folders, commit them with your work, and share them with your team. Press Cmd-Shift-A to save the current page as one; see Browser & Tabs for the rest.

Automations use the same files

An automation is a .ts file in the tree, and it reads and writes files next to itself with files. Access is explicit: files.write("out.md") needs write=out.md in the script’s permissions, and a script’s own folder isn’t granted for free. Pair it with ui.open to open the result in the editor as soon as it’s written.

Try it

The files-example folder in the examples repo has one sample of each type. Clone the repo (see Examples), open it as a project, and browse the tree.