Quickstart: clone, install, and run the Zorid desktop app

Clone the Zorid monorepo, install dependencies with pnpm, launch the Electron desktop app, and create your first typed note with an embedded view.

Zorid is a pnpm monorepo with Electron (desktop) and Capacitor (mobile) shells over a set of shared Vue 3 + TypeScript packages. In v0, the focus is the desktop experience.

Prerequisites

• Node.js 20+
• pnpm 9+
• Git
• A local folder to use as your vault (any directory of Markdown files)

Clone and install

1. Clone the repository

   git clone https://github.com/zorid-app/Zorid.git
   cd Zorid
   
2. Install dependencies

   pnpm install
   
3. Run the desktop app

   pnpm --filter @zorid/desktop dev
   

   The Electron window opens and prompts you to select a folder to use as your vault.

4. Run tests (optional)

   pnpm test
   

Your first typed note

Once the app is running and a vault is open, create a Type and a typed note.

1. Define a Type

   Create .zorid/types/task.ztype in your vault:

   schemaVersion: 1
   id: task
   name: Task
   
   fields:
     status:
       type: select
       options: [todo, doing, done]
       default: todo
     priority:
       type: select
       options: [low, medium, high]
       default: medium
     due:
       type: date
   
2. Create a typed note

   Create Tasks/Fix sync conflict UI.md:

   ---
   zorid:
     type: task
   status: todo
   priority: high
   due: 2026-06-01
   ---
   # Fix sync conflict UI
   

   Zorid renders the Task field group above the note body.

3. Embed a view

   Create .zorid/views/tasks.zbase:

   schemaVersion: 1
   id: tasks
   name: Tasks
   
   views:
     - type: table
       name: Table
       filters:
         and:
           - zorid.type == "task"
           - status != "done"
       sort:
         - property: due
           direction: ASC
   

   Embed it from any Markdown note:

   ![[.zorid/views/tasks.zbase]]
   

Next steps

Storage model

Where Markdown, .zbase, .ztype, and the SQLite index live.

Fields and Types

How frontmatter fields and .ztype schemas work together.

`.zbase` schema

View schema and the v0 filter grammar.

Core plugins

What ships in the box for v0.