| name | setup-workspace |
| description | Initialise a workspace, register projects under it, or sync upstream changes. Single entry point for workspace lifecycle. |
| user_invocable | true |
| args | Pick a mode based on user intent:
- `init --workspace <path> [--source <path>] [--dry-run]` — first-time workspace setup. Run from inside the cloned boilerplate folder; pass `--workspace` to point at the target. `--source` defaults to cwd when cwd is a v2 boilerplate; pass it explicitly only when running from elsewhere. `--dry-run` previews what would be created/skipped without writing anything.
- `add-project <slug> [description]` — scaffold a project under `<workspace>/projects/<slug>/` and register it via `/project-registry add`. Run from the workspace root.
- `sync` — pull upstream skill/agent updates from source. Diff-detects local changes and asks before overwriting.
|
/setup-workspace
Owns workspace lifecycle: init (first-time setup), add-project (register a project), and sync (update from source).
Workspace conventions
- Sibling layout. The boilerplate source clone and the workspace live at sibling paths — for example,
~/src/memnyx/ and ~/workspace/. Source must NOT live inside the workspace, and the workspace must NOT live inside the source. init refuses if the layout is wrong.
- Init runs once from the source clone. After init, the user works from the workspace; the source clone stays around for
/setup-workspace sync (upstream updates).
- Workspace =
cwd for add-project, sync, and ongoing work.
- Per v2 design principles: skills, agents, identity, brag log, MCP server configs, and the project registry all live in the workspace.
init --workspace <path> [--source <path>]
First-time workspace setup.
Why init runs from the source clone
Before init, the workspace's .claude/skills/ is empty — /setup-workspace doesn't exist there yet. So init is invoked from a Claude session started inside the cloned boilerplate, where the skill is already present. Init then deploys the skill (and everything else) into the target workspace. After init, the user starts fresh sessions from the workspace.
Invocation
cd ~/src/memnyx # or wherever you cloned it
claude
/setup-workspace init --workspace ~/workspace
--source defaults to cwd. Pass --source <path> only when running from somewhere other than the source clone.
A v2 boilerplate is identified by the marker file .claude/skills/setup-workspace/templates/workspace-CLAUDE.md.tmpl. init refuses if cwd is not a v2 boilerplate and --source is not provided.
Prerequisites
- The boilerplate cloned to a folder OUTSIDE the intended workspace (e.g.,
~/src/memnyx/).
- The target workspace folder need not exist — init creates it (missing parents included).
- Confirm workspace and source paths with the user before invoking the script (the agent reads the values from script output and asks).
Dry run
Pass --dry-run to preview what init would do without writing anything. The script prints the same created/skipped summary, prefixed with [DRY RUN]. Useful when the user wants to verify the plan before committing. The agent should default to running --dry-run first when paths haven't been confirmed, then re-run without it.
Behavior
The init action is idempotent. Re-running is safe:
- Skills, agents, and
agent-guardrails.md are overwritten from source (always fresh — these are upstream-owned).
- Other docs (
architecture.md, conventions.md, cognee-usage.md, etc.) are deployed only if missing in the workspace (templates, evolved by the user after init).
CLAUDE.md (base) is generated from the template only if missing; CLAUDE.fork.md (fork overlay) is deployed only if missing and only when the source is a fork; CLAUDE.local.md (native local overlay) is seeded only if missing. MEMORY.md, lessons-learned.md, project-context.md, me/*.md, .gitignore, settings.json are likewise deployed only if missing — never overwritten.<workspace>/shell/memnyx.sh (the mmn launcher) is a derived artifact — overwritten on every init and sync. The user's shell profile is edited only with explicit consent, and only via an idempotent managed block (a one-time .memnyx-backup of the profile is saved before the first edit).
Steps
- Resolve workspace and source.
--workspace is required; --source defaults to cwd when cwd is a v2 boilerplate. The script validates the sibling layout (refuses if source and workspace overlap) and prints both paths — confirm with the user before proceeding.
- Create scaffolding (idempotent):
- At workspace root:
workstreams/, sessions/active/, artifacts/, me/.
- Under
.claude/: memory/, skills/, agents/, docs/.
- Deploy from source:
<source>/.claude/skills/* → <workspace>/.claude/skills/ (overwrite).<source>/.claude/agents/* → <workspace>/.claude/agents/ (overwrite, if source has agents).<source>/.claude/docs/agent-guardrails.md → <workspace>/.claude/docs/agent-guardrails.md (overwrite).- Other
<source>/.claude/docs/* → <workspace>/.claude/docs/ (deploy only if missing — these are templates).
- Generate the layered
<workspace>/CLAUDE.md (skip if exists): render templates/workspace-CLAUDE.md.tmpl, substituting {{fork_overlay_include}} with an @CLAUDE.fork.md include when the source is a fork that ships an overlay template (git-provenance check), else nothing. Then deploy CLAUDE.fork.md from the fork overlay template (forks only; skip if exists) and seed CLAUDE.local.md (skip if exists). CLAUDE.local.md loads natively alongside CLAUDE.md, so it is never @-included. Two guards on the overlays: if an existing CLAUDE.md is a legacy monolith (lacks the ## Layered overlays marker) — or is unreadable / not valid UTF-8 — both overlays are held (skipped with a reason) until the user runs the one-time split, so init never orphans a fork overlay the base does not include nor duplicates Conventions into the local seed. And any layer destination that is a symlink is refused before writing (it could redirect the write outside the workspace) — remove the symlink and re-run. The same two guards apply on sync --apply-all.
- Deploy starter files (skip if exists):
<workspace>/.claude/memory/MEMORY.md — empty header.<workspace>/.claude/memory/lessons-learned.md — empty header.<workspace>/.claude/memory/project-context.md — workspace-level domain context template (user fills in).<workspace>/me/identity.md — placeholder profile (user fills in).<workspace>/me/brag-log.md — empty header.<workspace>/me/growth.md — empty header.<workspace>/.gitignore — gitignores per-engineer working state.
- Settings.json: copy from source only if
<workspace>/.claude/settings.json is missing. If exists, skip with a note suggesting /setup-workspace sync for future updates.
- Print summary: what was created, what was skipped, and suggested next steps (
/setup-workspace add-project, /setup-cognee).
- Offer to wire the shell launcher (consent-gated).
init.py has already written <workspace>/shell/memnyx.sh (the mmn command — see Shell launcher below); that file is safe and unconditional. The only thing left is editing the user's shell profile so it sources that file — which init.py deliberately does NOT do. Show the user the detected profile and the managed source block, ask for explicit consent, and only then run launcher.py --wire-profile. If they decline, the block is theirs to add by hand. Offer this; never wire a profile silently.
Implementation
The init action is delegated to scripts/init.py:
python3 .claude/skills/setup-workspace/scripts/init.py --workspace <path> [--source <path>] [--dry-run]
When run from cwd = source clone (the recommended flow), the relative path above works. From elsewhere, use the absolute path to the script in the source. init.py writes <workspace>/shell/memnyx.sh itself (step 8) — so the launcher always exists after init, no separate write step needed.
Only the profile wiring is a separate, consent-gated call (step 8). After the user consents:
python3 .claude/skills/setup-workspace/scripts/launcher.py --workspace <path> --wire-profile [--profile <path>] [--shell <name>]
--profile overrides shell-based detection — use it when the user's setup differs (e.g. macOS login bash that reads ~/.bash_profile, not ~/.bashrc). Run with --dry-run first to preview the exact profile edit.
add-project <slug> [description]
Scaffold a project under <workspace>/projects/<slug>/ and register it via /project-registry add.
Inputs
<slug> — required. Lowercase + hyphens; must start with a letter. Same shape as /project-registry add.<description> — optional one-line. Stored on the registry entry and substituted into the project's CLAUDE.md.
Prerequisites
Dry run
Pass --dry-run to preview what would be created/skipped/patched without writing anything. Particularly useful when the project dir is a symlink to an existing repo: confirms whether an existing CLAUDE.md or .gitignore would be preserved (or surgically patched) as-is, and which gitignore patterns would be appended.
Behavior
The action is idempotent. Re-running is safe:
- Existing starter files (
MEMORY.md, lessons-learned.md, project-context.md, settings.json) are preserved — never overwritten.
- A pre-existing
CLAUDE.md (typical when symlinking to a real repo that already has its own) is never regenerated or overwritten. If it already has the @.claude/memory/MEMORY.md include, it's left untouched. If not, the ## Memory section is surgically appended from the template — the rest of the file is preserved verbatim. Re-running is safe: the include-marker check means the section is never appended twice.
.gitignore is created fresh if missing, or appended in-place with only the patterns it lacks (line-by-line check)./project-registry add is skipped when the slug is already registered.
Steps
- Pre-flight checks:
- cwd looks like a v2 workspace (has
.claude/skills/setup-workspace/).
- slug matches
^[a-z][a-z0-9-]*$.
<workspace>/projects/<slug>/ exists (real dir or symlink).
- Create directories at the project root:
workstreams/, sessions/active/, artifacts/, .claude/memory/. Skip if exists.
- Write starter files (skip if exists):
.claude/memory/MEMORY.md — empty header..claude/memory/lessons-learned.md — empty header..claude/memory/project-context.md — project-level domain context template (user fills in: business domain, users, constraints, what "done" looks like)..claude/settings.json — empty {}. Project-level allowlists evolve here as the project's needs surface; user-specific layers go into settings.local.json (gitignored).
- Generate or patch
CLAUDE.md from templates/project-CLAUDE.md.tmpl with {{project_name}} and {{description}} substituted.
- No existing file → generate the full template.
- Existing file, already has
@.claude/memory/MEMORY.md → skip, untouched.
- Existing file, missing the include → surgically append just the template's
## Memory section (extracted up to its next heading) to the end of the file. Everything already in the file is preserved verbatim.
- Update
.gitignore at the project root: append workstreams/, sessions/, collected/, artifacts/, contributions/. Idempotent — line-by-line check; only missing patterns are added.
- Register via
/project-registry add — the registry receives <slug> [description]. Skipped when the slug is already registered.
- Print summary: what was created, what was patched, what was skipped.
Why collected/ and contributions/ aren't scaffolded
These dirs are created by their owning skills on first use (mirrors the init pattern at the workspace level). Pre-creating empty dirs pollutes git status until something actually lands in them; deferring keeps the project clean until the dir is actually needed.
Implementation
The add-project action is delegated to scripts/add_project.py:
python3 .claude/skills/setup-workspace/scripts/add_project.py <slug> [description] [--dry-run]
The script handles validation, idempotent scaffolding, template substitution, and the registry call. Output goes to stdout in human-readable form.
sync
Update upstream-owned content in the workspace from the source clone, and surface any new starter files (memory entries, identity templates, etc.) that have been added to Memnyx since init. Conservative — detects local changes and asks for consent before overwriting.
When to use
After the user pulls upstream changes into the source clone (e.g., cd ~/src/memnyx && git pull) and wants those changes reflected in the workspace.
Inputs
--workspace <path> — required. The target workspace.--source <path> — optional. Defaults to the path stored in <workspace>/.claude/.source by init. Pass explicitly only if the source clone has moved or if .source is missing.
Behavior
Walks three surfaces and reports them in separate sections:
- Upstream-owned content —
.claude/skills/**, .claude/agents/**, .claude/docs/agent-guardrails.md. Bucketed as unchanged, update, new, local-only. update and new are actionable; local-only is never touched.
- Starter files —
templates/starters/workspace/** mapped to workspace paths plus, for each registered project, templates/starters/project/** mapped to the project's paths. Bucketed the same way but the update bucket is suppressed — it surfaces as divergent (informational only). Starters are user-evolved after init; sync never offers to overwrite a workspace copy that has diverged.
- CLAUDE.md layers (reconciled only on
--apply-all) — the base CLAUDE.md and the CLAUDE.fork.md overlay are regenerated from their templates (upstream-/fork-owned); CLAUDE.local.md is seeded only if missing and never overwritten (user-owned). Two guards hold all three layers: if the source's git origin can't be classified (canonical vs fork), or the base is a legacy monolith lacking the ## Layered overlays marker, the layers are left untouched.
Only new starters are actionable. When a starter feedback_*.md lands under .claude/memory/, sync emits a hint reminding the user that the matching index line in MEMORY.md was not added automatically (because the user's MEMORY.md is itself a starter that's diverged).
Reconciles the CLAUDE.md layers as above (base + fork overlay regenerated; CLAUDE.local.md seeded-if-missing, never overwritten), refusing any layer whose destination is a symlink. Does NOT touch workstreams, sessions, settings.json, other docs/* templates, or the contents of CLAUDE.local.md. The starter walk reports divergence for memory/identity files but never overwrites.
Steps
- Pre-flight: confirm cwd is the workspace (
.claude/.workspace present). Resolve source via --source or .claude/.source.
- Run the planner:
python3 .claude/skills/setup-workspace/scripts/sync.py --workspace <path> [--source <path>]. The script prints a structured plan with file paths grouped by category, with separate sections for upstream-owned content and starters.
- Show the user the plan. For non-empty
update, new, and starter new sections, ask:
- Apply all (
--apply-all)?
- Apply specific files (collect a list of relative paths or starter display paths)?
- Show a diff for any file before deciding (use
diff on the actual source/workspace paths)?
- Skip entirely?
- Apply chosen changes: re-run
sync.py with --apply-all or --apply <relpath>.... The script copies source-version files to the workspace and prints what was applied. If a feedback_*.md starter landed, also surface the hint so the user can manually add the index line to their MEMORY.md.
- Print summary: what was applied, what was kept, what remains as
local-only or starter divergent (so the user knows their custom additions are preserved).
- Shell launcher.
sync.py regenerates <workspace>/shell/memnyx.sh from the (possibly updated) template automatically on every apply — a derived artifact, no separate step. Only if the profile's managed block is missing (or the user asks) do you offer launcher.py --wire-profile (consent-gated, exactly as in init). Never edit the profile without consent.
Implementation
python3 .claude/skills/setup-workspace/scripts/sync.py --workspace <path> [--source <path>] [--apply <relpath>...] [--apply-all]
Default mode (no --apply flags) prints the plan only; apply mode also regenerates shell/memnyx.sh (it imports launcher.write_memnyx_sh).
Shell launcher (mmn)
init and sync write <workspace>/shell/memnyx.sh and — with explicit consent — wire it into the user's shell profile via an idempotent managed block. It defines one command, mmn, for engineers who prefer launching from a project clone over the workspace root:
mmn — launch Claude in the current folder with --add-dir <workspace>, so the workspace's skills load.mmn <slug> — cd to the real clone of the registered project <slug> (resolving the projects/<slug> symlink via cd + pwd -P), then launch. The project's own .mcp.json/settings load; an unrecognised slug is refused, not guessed.
Before launching, mmn prints a banner showing the directory it will cd into and the exact command it runs (the CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 claude --add-dir … line) — no hidden behaviour. Colour is used only on a TTY.
This is the supported secondary launch flow in docs/v2-design-principles.md: /hello binds such a session by matching realpath(cwd) to a registered project. memnyx.sh is POSIX-safe (sh/bash/zsh) and derived — never hand-edit it; change templates/memnyx.sh.tmpl instead. The launcher exports MEMNYX_WORKSPACE and scopes CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 to the command, so the workspace CLAUDE.md loads via --add-dir without affecting other claude invocations.
Important rules
- Idempotent. Re-running any action is safe.
- Never overwrite user content. MEMORY.md, lessons-learned.md, identity, brag log, growth, gitignore, settings.json, and
CLAUDE.local.md — once present, stay as the user has them. The base CLAUDE.md and the CLAUDE.fork.md overlay are upstream-/fork-owned (generated from templates, reconciled by sync); workspace-specific instructions belong in CLAUDE.local.md, which sync never overwrites.
- Init overwrites upstream-owned content; sync asks. Skills, agents, agent-guardrails.md are Memnyx's contract —
init overwrites them unconditionally (first-time setup, no local edits to protect). sync is conservative: detects local edits and asks the user before overwriting (workspace has evolved since init).
- Refuse, don't guess. If the source can't be uniquely identified, fail with a clear hint rather than picking arbitrarily.
- No project scaffolding here. That's
/setup-workspace add-project's job, not init's.
