Getting started

Flynt is a project workspace built around files you own. A project is just a folder; Markdown stays readable outside Flynt.

What Flynt is for

Use Flynt when a folder has become more than loose notes: tasks, diagrams, saved views, agent context, release notes, architecture docs, and project operations all need to stay connected.

• Write is the markdown editor and tabbed note surface.
• Files shows the project tree without forcing a proprietary database.
• Graph shows relationships between notes, tasks, boards, and project artifacts.
• Lenses are saved live views over project state.
• Tasks turns kanban/task files into navigable project knowledge.
• Design covers drawings, D2 diagrams, design boards, and flow graphs.
• Omegon embeds the project-scoped agent runtime.

First run checklist

1. Install Flynt from the latest macOS release.
2. Open a folder: start with an existing markdown folder, a code repository, or a small scratch project.
3. Create one note in Write. Use normal Markdown. Link another note with [[wikilinks]].
4. Open Graph to confirm the relationship appears. Large projects may open in overview mode first.
5. Create a task board if the project has work items you want to track.
6. Open Omegon only when you want the embedded agent to inspect, edit, or automate the project.

Project layout

Flynt avoids hiding your work in an app-only database. The project folder remains the authority. Flynt adds metadata and local indexes around it.

my-project/
  notes.md
  guides/
  drawings/            # Excalidraw drawings and wrappers
  diagrams/            # D2 diagrams
  boards/              # design boards
  flows/               # node-flow graphs

  .flynt/              # Flynt-owned metadata and generated state
    config.toml        # portable project settings when enabled
    templates/         # note templates
    lenses/            # saved live views
    local/             # generated local state, gitignored
    runtime/           # runtime integration contracts, gitignored

  .omegon/             # Omegon-owned project-local agent/runtime state

Safe defaults for existing folders

When Flynt opens an existing code repository or large folder, it should behave conservatively. It indexes what it can, avoids unnecessary frontmatter writes unless configured, delays expensive watcher work until after first paint, and keeps large graph renders bounded by default.

Document dates

The note header shows created and modified dates. Flynt prefers explicit frontmatter when present, preserves existing store state, and can derive dates from Git history for existing repositories. These dates are project metadata, not “when Flynt happened to index the file.”

Dot-prefixed files

The Files sidebar hides dot-prefixed metadata/runtime paths by default. Use the .hidden toggle when you need to inspect project-local runtime files.

Where to go next

• Project surfaces explains each workspace view.
• Coming from Obsidian? maps vault concepts to Flynt.
• Performance and large projects explains large-workspace behavior.
• Sync posture explains what Flynt does and does not promise about sync.