Skip to content

workspace-schema.md

Latest commit

 

History

History
51 lines (38 loc) · 1.35 KB

workspace-schema.md

File metadata and controls

51 lines (38 loc) · 1.35 KB

Workspace schema

This document defines the .devman/devman.toml schema used by devman.

Overview

  • Required fields are listed explicitly.
  • All paths are relative to the .devman/ directory unless noted.
  • TOML overrides .env values if both are present.

Schema

[workspace]
name = "my-app"           # required
tags = ["api", "web"]    # optional
group = "client-x"       # optional

[tmuxp]
workspace = "workspace.tmuxp.yaml" # optional
session_name = "my-app"            # optional

[claude_code]
interaction = "interaction.md"     # optional
emit_project_config = false         # optional

[nvim]
init = "nvim/init.lua"             # optional
listen = ".devman/.state/nvim.sock" # optional (relative to workspace root)
sessions_dir = "sessions"           # optional
default_session = "home.vim"         # optional

Precedence rules

  1. .devman/devman.toml is the primary configuration source.
  2. .devman/.env may supply environment toggles for:
    • DEVMAN_TMUXP_WORKSPACE
    • DEVMAN_SESSION_NAME
  3. If TOML fields are present they always override .env values.

Required files

A workspace is valid if .devman/ exists. The following files are optional but recommended for full functionality:

  • .devman/devman.toml
  • .devman/interaction.md
  • .devman/workspace.tmuxp.yaml
  • .devman/nvim/init.lua
  • .devman/sessions/home.vim