workmesh/README.json at main · luislobo/workmesh · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
{
  "name": "WorkMesh",
  "tagline": "Docs-first project and task orchestration for developers and coding agents.",
  "summary": [
    "WorkMesh keeps repo-local planning state next to code.",
    "Primary human documentation lives in docs/README.md.",
    "README.md is a short landing page with install and links."
  ],
  "artifacts": {
    "cli": "workmesh",
    "mcp": "workmesh-mcp",
    "core": "workmesh-core",
    "render": "workmesh-render",
    "tools": "workmesh-tools",
    "mcp_server": "workmesh-mcp-server"
  },
  "storage": {
    "repo_local": [
      "tasks/",
      ".workmesh/context.json",
      ".workmesh/truth/",
      "docs/projects/<project-id>/"
    ],
    "global": [
      "~/.workmesh/"
    ]
  },
  "install": {
    "verify": [
      "workmesh --version",
      "workmesh-mcp --version"
    ],
    "build_from_source": [
      "git clone git@github.com:luislobo/workmesh.git",
      "cd workmesh",
      "cargo build -p workmesh",
      "cargo build -p workmesh-mcp"
    ],
    "codex_mcp_example": {
      "command": "/usr/local/bin/workmesh-mcp",
      "args": []
    }
  },
  "canonical_docs": {
    "manual": "docs/README.md",
    "architecture": "docs/architecture.md",
    "commands": "docs/reference/commands.md",
    "setup": "docs/setup/run-modes-and-agent-mcp.md",
    "changelog": "CHANGELOG.md"
  },
  "workflow": {
    "mode": "codex-first",
    "entry_prompts": [
      "Bootstrap WorkMesh in this repo. Use MCP if available, otherwise CLI.",
      "Use WorkMesh for this feature end to end. Create/update PRD, create and maintain tasks with acceptance criteria and definition of done, keep context current, and track stable decisions in Truth Ledger."
    ],
    "resume_prompt": "Rehydrate this session with WorkMesh. Read current context, accepted truths, active workstream state, and next actionable tasks. Then summarize what I was doing, what constraints still apply, and the next concrete step."
  },
  "skills": {
    "router": "workmesh",
    "cli": "workmesh-cli",
    "mcp": "workmesh-mcp",
    "shared_doctrine": "Each canonical skill bundles the same operating doctrine covering task quality, compaction-safe persistence, truth/note/task boundaries, and output rules.",
    "canonical_source_dir": "skills/",
    "project_paths": {
      "codex": ".agents/skills/",
      "cursor": ".agents/skills/",
      "claude": ".claude/skills/"
    },
    "user_paths": {
      "codex": "~/.codex/skills/",
      "cursor": "~/.cursor/skills/",
      "claude": "~/.claude/skills/"
    }
  },
  "rules": {
    "task_sections": [
      "Description",
      "Acceptance Criteria",
      "Definition of Done"
    ],
    "actionable_statuses": [
      "To Do",
      "In Progress"
    ],
    "draft_statuses": [
      "Draft",
      "Needs Refinement"
    ],
    "task_creation": "By default, new actionable tasks must provide description, acceptance criteria, and definition of done. Use explicit draft mode for incomplete tasks. Repos can override the required task-quality fields in config.",
    "definition_of_done": "By default, Definition of Done must be outcome-based, not hygiene-only. This requirement is configurable.",
    "task_quality_config_keys": [
      "task_require_description",
      "task_require_acceptance_criteria",
      "task_require_definition_of_done",
      "task_require_outcome_based_definition_of_done"
    ],
    "maintenance_fixers": [
      "uid",
      "deps",
      "ids",
      "filenames"
    ],
    "mutation_responses": "Compact by default; use verbose=true only when richer post-write state is required.",
    "resume_checklist": [
      "restore current context",
      "read accepted truths for current scope",
      "inspect workstream restore state if parallel work exists",
      "identify the active task or smallest valid working set",
      "summarize current objective, constraints, and next step before new implementation work"
    ]
  },
  "architecture": {
    "workmesh-core": "domain logic, storage, state",
    "workmesh-render": "renderers",
    "workmesh-tools": "shared tool contract",
    "workmesh": "CLI adapter",
    "workmesh-mcp-server": "MCP adapter",
    "workmesh-mcp": "stdio wrapper"
  }
}