{"id":50380939,"url":"https://github.com/avelino/outl","last_synced_at":"2026-05-31T13:00:32.671Z","repository":{"id":360512668,"uuid":"1248334245","full_name":"avelino/outl","owner":"avelino","description":"Local-first outliner. Markdown is the source of truth. Sync that doesn't corrupt your tree when two devices edit offline","archived":false,"fork":false,"pushed_at":"2026-05-30T10:17:47.000Z","size":13029,"stargazers_count":3,"open_issues_count":18,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-30T12:20:17.477Z","etag":null,"topics":["markdown","notes-app","outliner"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/avelino.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-24T14:04:46.000Z","updated_at":"2026-05-30T11:43:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/avelino/outl","commit_stats":null,"previous_names":["avelino/outl"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/avelino/outl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelino%2Foutl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelino%2Foutl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelino%2Foutl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelino%2Foutl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/avelino","download_url":"https://codeload.github.com/avelino/outl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/avelino%2Foutl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33731998,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-31T02:00:06.040Z","response_time":95,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","notes-app","outliner"],"created_at":"2026-05-30T12:01:27.711Z","updated_at":"2026-05-31T13:00:32.622Z","avatar_url":"https://github.com/avelino.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" alt=\"outl\" width=\"160\" height=\"160\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eoutl\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  Local-first outliner. Markdown is the source of truth. Sync that\n  doesn't corrupt your tree when two devices edit offline.\n\u003c/p\u003e\n\nInspired by [Roam Research](https://roamresearch.com) and\n[Logseq](https://logseq.com). Picks what they got right (graph,\nbacklinks, daily journal, block-level thinking) and fixes the part\nthey didn't.\n\n## The bet — a sync that's *provably* correct\n\nThis is the differentiator. Everything else builds on it.\n\nRoam keeps your notes on their servers; if two devices edit while\noffline, the later write silently wins. Logseq scatters `id::` UUIDs\nthrough your `.md` so its rsync-flavoured \"sync\" has something to\nmatch on; concurrent moves still lose data. `git`-as-sync produces\nconflict markers across nested bullets every time.\n\noutl uses the **[Kleppmann et al. 2022 tree CRDT][paper]** — the\nsame family of algorithm that backs Automerge and Y.js, adapted\nspecifically for trees. Two devices that edit a workspace offline\nand then sync produce **exactly the same tree**, with **no data\nloss**, **without a server**, and **without polluting your\n`.md`**. The IDs CRDTs need to operate live in a separate sidecar\nfile (`foo.outl` next to `foo.md`), so the markdown you see is the\nmarkdown you wrote — no `id::` lines, no UUIDs, no HTML comments.\n\nFive formal guarantees, each backed by a test in\n[`crates/outl-core/tests/`](crates/outl-core/tests/):\n\n1. **Strong eventual consistency** — same set of ops → same tree, any order.\n2. **Commutative after reordering** — late arrivals don't break the result.\n3. **Idempotent** — applying an op twice is the same as once.\n4. **Tree invariant always holds** — no node ever has two parents, no cycles.\n5. **No silent loss** — every op stays in the log, even ones turned into no-ops by cycle detection.\n\n→ **[Sync, done right](docs/sync.md)** walks through *why* Roam,\nLogseq and Git fail, then the algorithm step by step.\n\n→ **[Tree CRDT walkthrough](docs/crdt.md)** is the algorithm with code.\n\n**Working sync today.** outl already syncs across a macOS TUI and an\niOS mobile app via iCloud Drive: one `ops-\u003cactor\u003e.jsonl` per device,\nno central server, no merge dialogs. The Kleppmann move-op core sits\nunder everything; iCloud is just transport. P2P (iroh) on\n[the roadmap](docs/roadmap.md) replaces the transport later without\ntouching the algorithm.\n\n[paper]: https://martin.kleppmann.com/papers/move-op.pdf\n\n## What's in the box today (0.1.0)\n\n- **TUI** — journal-first, vim-style keys, slash commands (`/`),\n  fuzzy switcher (`Ctrl+P`), workspace search, multi-line blocks,\n  fenced code blocks, themes, hot-reload on external `.md` edits.\n- **Markdown clean as you wrote it** — `title::`, `icon::`, `tags::`\n  properties live in plain `key:: value` lines at the top; outline\n  is standard CommonMark bullets. No metadata smuggled in.\n- **Page icons** — `icon:: 🚀` on a page surfaces everywhere it's\n  referenced (header, switcher, backlinks panel, `[[ref]]` inline).\n- **Block references and embeds** — `((blk-XXXXXX))` resolves inline\n  to the source block's text + page icon. `!((blk-XXXXXX))` expands\n  the source block **and its children** read-only below the carrying\n  block (each row prefixed with `↳ `, children indented to align with\n  the source's text). `Enter` on any handle jumps to the source page\n  and lands the cursor on the referenced block. Short, deterministic,\n  sidecar-backed handles — the `.md` stays human-typeable. `((` in\n  Insert mode pops a fuzzy-match autocomplete; `y r` (or `/refer` /\n  `/refer-embed`) copies the current block's handle to the OS\n  clipboard for paste anywhere.\n- **Code blocks that run** — ` ```lisp / ```js / ```python / ```lua /\n  ```rust `, the result lands as a `\u003e **result:**` subblock under\n  the source. Re-runs are idempotent. Set `auto-run::` on a block\n  and it re-runs whenever you open the page (cache-aware by source\n  hash). Powered by [`outl-exec`](crates/outl-exec/) — language\n  registry is plugin-shaped, more languages drop in as 80-line\n  adapters.\n- **Importers** — `outl import logseq` and `outl import roam`\n  strip `id::` lines, resolve `((uid))` block refs, slugify\n  filenames, seed sidecars.\n- **Bench harness** — `cargo bench -p outl-md` measures parse +\n  index over synthetic workspaces from 15 files up to 10.500. CI\n  runs the smaller tiers on every PR; the 10k-file tier on a\n  weekly cron.\n\n## Quick start\n\n```bash\ngit clone https://github.com/avelino/outl.git \u0026\u0026 cd outl\ncargo build --release\n\n./target/release/outl init ~/notes\n./target/release/outl --path ~/notes\n```\n\n`outl` (no subcommand) opens the TUI on the workspace and lands on\ntoday's journal. Press `?` for keymap, `:` for the command palette,\n`Ctrl+P` to fuzzy-jump to any page.\n\n## Coming from Logseq or Roam?\n\n```bash\noutl import logseq ~/path/to/logseq-graph ~/notes\noutl import roam ~/Downloads/backup.json ~/notes\n```\n\nThe importer strips `id::` lines, resolves `((uid))` block refs to\npage links, slugifies filenames, and seeds the sidecars. Anything it\ncan't resolve stays as `((unresolved:UID))` for manual triage.\n\n## Status\n\n**0.3.0 — cross-device daily driver.** Workspace, TUI, and iOS mobile\napp share the same `outl-core` + `outl-md` + `outl-actions` stack and\nsync across devices via iCloud Drive. The CRDT, op log, sidecar, and\nreconcile pipeline are working end-to-end (edit on the laptop, the\niPhone updates within seconds; concurrent edits converge without\nprompts). The P2P transport (iroh, phase 2) and the Tauri desktop\nshell (phase 5) are still ahead — see [the roadmap](docs/roadmap.md).\nThe mobile client is Tauri 2 + SolidJS, which replaces the earlier\nuniffi plan (decision in [`docs/architecture.md`](docs/architecture.md)).\n\n## Docs\n\nWant to actually learn how this works?\n\n→ **[docs.outl.app](docs/README.md)** — full GitBook, with the sync\nalgorithm walked through step by step, the TUI manual, theming, and\ncontributing notes.\n\n## Background reading\n\nThe engineering decisions behind outl are written up on\n[avelino.run](https://avelino.run) as the project moves:\n\n- **[File sync isn't trivial](https://avelino.run/file-sync-isnt-trivial/)**\n  — why concurrent file moves are a distributed-systems problem that\n  Dropbox and Google Drive still get wrong, and what the Kleppmann\n  et al. 2022 paper proves about a path out.\n- **[From paper to outliner](https://avelino.run/from-paper-to-outliner/)**\n  — the gap between \"the CRDT converges\" and \"the app ships\":\n  projections, content-addressable reconciliation, ignoring your own\n  writes, surviving iCloud's lazy materialisation.\n\n## License\n\n[MIT](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favelino%2Foutl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favelino%2Foutl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favelino%2Foutl/lists"}