![~/workspace](../images/banner.png)

# ~/workspace

A private, terminal-themed workspace that runs in the browser: a diary, the
notes for work and for uni, a board per space, and the files that go with them.
One user, one SQLite file, one binary. Everything is a key or a `:` command on
the desktop, and a button on the phone.

It keeps four things: **documents**, the thorough record; **cards**, the short
summary of work, usually about a document; **notes**, jotted in passing on the
scratchpad until they become one of the others; and **diary entries**. The
[guide](Guide.md#four-things-two-screens) says how they fit together.

![A document open in the reader](../images/document.png)

## Where to start

- **[Getting started](Getting-Started.md)**: run it, log in, find your way
  around in the first ten minutes.
- **[The guide](Guide.md)**: a day with the workspace, from the morning's
  agenda to the evening's diary entry, with every part explained on the way.
- **[Keys and commands](Commands.md)**: the full list, the same one `?` shows.

## The parts

| page | what it covers |
| --- | --- |
| [Spaces and documents](Spaces-and-Documents.md) | spaces, folders, the list, tiles, moving things |
| [Writing](Writing.md) | the editor, vim, the scratchpad, markdown, math, links between documents, templates |
| [Boards and the agenda](Boards-and-Agenda.md) | cards, due dates, cards that come back, the plan screen, the agenda |
| [The diary](Diary.md) | entries, today, the calendar, on this day |
| [Files and search](Files-and-Search.md) | uploads, what opens in place, full-text search |
| [Not losing things](Not-Losing-Things.md) | autosave, history, the trash, export and import |
| [The vault](Vault.md) | files sealed under a password of their own |
| [Capture](Capture.md) | writing things down from a phone or a script |
| [Sharing](Sharing.md) | read-only links to one document |
| [The SFTP mount](SFTP.md) | the workspace as a filesystem |
| [Backup and mail](Backup-and-Mail.md) | Proton Drive mirror, reminders and digests |
| [Deploying](Deploying.md) | running it on a server, behind a proxy, in Docker |
| [Configuration](Configuration.md) | every setting |
| [API](API.md) | every route |
| [Development](Development.md) | the code, the checks, the screenshots and this wiki |

## Screens

| | |
| --- | --- |
| ![Two documents in tiles](../images/tiles.png) | ![The board of a space](../images/board.png) |
| Two documents side by side, each in a tile of its own. | A board: the first list is the inbox, the last is done. |
| ![The agenda](../images/agenda.png) | ![The diary by month](../images/calendar.png) |
| The agenda: what is late, due, or in hand, on every board. | The diary by month. |
| ![Search reaching into a log file](../images/search.png) | ![A certificate read in place](../images/file-certificate.png) |
| A search finds the text inside files too. | Certificates and keys are read on the server. |
| ![The scratchpad](../images/scratch.png) | ![A document's info sheet](../images/info.png) |
| The scratchpad, lowered over the documents. | The cards about a document, in its info sheet. |