Skip to content

Workspaces & Projects

Every demo in CutReady lives inside a project, which is part of a workspace. A workspace is a git repository directory that can contain one or more projects. Each project holds sketches, storyboards, notes, screenshots, and visuals; the workspace’s .git/ directory holds version history.

Project file tree Project file tree
The Explorer shows all project files — sketches (.sk), storyboards (.sb), and notes (.md)
TermMeaning
WorkspaceA git repository directory. This is what you open or clone in CutReady.
ProjectA unit of work within a workspace. Contains its own sketches, storyboards, and notes.

A workspace can operate in single-project mode (the default when you open an empty git repo) or multi-project mode (when you add additional projects).

  1. Open CutReady — You’ll see the Home screen with your recent workspaces.

  2. Click “New Workspace” — A system folder picker opens. Choose or create a folder where CutReady will initialize a workspace.

  3. Name your project — Enter a descriptive title like “Product Demo Q1”. CutReady initializes the folder with a project.json manifest and a .git/ directory for version history.

Use “Open Workspace” on the Home screen to browse to an existing CutReady workspace folder. CutReady detects the project.json file and loads the workspace.

Your most recently used workspaces appear in the Recent Workspaces list on the Home screen for quick access.

A single workspace can contain multiple projects. This is useful for organizing related demos, different versions of a presentation, or team collaboration.

Use the ProjectSwitcher in the sidebar to create a new project within the current workspace. Each project gets its own subdirectory with an independent set of sketches, storyboards, and notes.

The ProjectSwitcher dropdown in the sidebar shows all projects in the workspace. Click a project name to switch to it. Your current project state is preserved and restored when you switch back.

Click the pencil icon (✏️) next to the project name in the ProjectSwitcher to rename it.

Right-click any sketch, storyboard, or note in the sidebar to see Move to and Copy to submenus listing the other projects in the workspace. Referenced screenshots and visuals are transferred automatically. If a file with the same name already exists in the destination project, a rename dialog appears.

When you add a second project to a single-project workspace, CutReady automatically runs a migration flow:

  1. Existing files are moved into a project subdirectory
  2. A .cutready/projects.json manifest is created to track all projects
  3. The workspace is now in multi-project mode

This is seamless — your existing files and version history are preserved.

my-workspace/
├── project.json ← Project manifest (name, metadata)
├── .cutready/
│ ├── screenshots/ ← Captured and pasted images
│ ├── visuals/ ← Elucim DSL visual files
│ └── settings.json ← Workspace settings overrides
├── .git/ ← Version history (managed by gix)
│ └── cutready/ ← Local UI state such as ordering and open tabs
├── intro.sk ← Sketch file
├── demo-flow.sb ← Storyboard file
└── research-notes.md ← Markdown note
my-workspace/
├── .cutready/
│ └── projects.json ← Multi-project manifest
├── .git/ ← Shared version history
├── project-alpha/
│ ├── project.json
│ ├── .cutready/
│ │ ├── screenshots/
│ │ └── visuals/
│ ├── intro.sk
│ └── demo-flow.sb
└── project-beta/
├── project.json
├── .cutready/
│ ├── screenshots/
│ └── visuals/
├── overview.sk
└── notes.md
ExtensionTypeDescription
.skSketchStructured planning table with narrative, actions, and screenshots
.sbStoryboardOrdered sequence of sketch references
.mdNoteFree-form markdown document
.png / .jpgScreenshotReference images under .cutready/screenshots/
.jsonVisualElucim DSL visuals under .cutready/visuals/

The project.json file at the root of every project stores the project name and metadata. CutReady reads this file to identify a directory as a valid project.

Explorer Ordering (.git/cutready/order.json)

Section titled “Explorer Ordering (.git/cutready/order.json)”

The .git/cutready/order.json file persists the order of documents in the Explorer. When you drag-and-drop documents to rearrange them, CutReady writes the new order to this local UI-state file so it is preserved across sessions without adding noise to snapshots. Older workspaces may still contain .cutready-order.json; CutReady migrates it automatically.

Each workspace contains an embedded .git/ directory managed by gitoxide (gix), a pure-Rust git implementation. This is completely independent of any source code repositories — it’s used solely for document version tracking.

Captured and pasted screenshots are stored in .cutready/screenshots/ inside the project. When you use screen capture from a sketch row, the image file is saved there and referenced by relative path from the sketch.