setup

---
name: setup
description: "Configure a project so the set can run in it: confirm the project root, install git, waymark, node, and the GitHub CLI and sign them in, initialize the tracker, install the rules and the runtimes, write the AGENTS.md pointer, and open the first map. Use when the project has no .waymark/config.toml, when .agents/rules/ is empty, or when a clone cannot run the set."
family: setup
invocation: user
---

# Setup

Before choosing a flow or changing anything, read `rules/rules-install.md` from this installed skill. Resolve and confirm the project root with the person, and follow that rule throughout.

This file routes. The flow documents hold the steps; `install.md` holds what gets installed and how.

## Which flow

| The project | Flow |
|---|---|
| Empty, or no tracker yet | `configure-project.md`: take it to a configured project, open its root map, and stop before the commit |
| A clone of a project that already uses waymark | `join-project.md`: fill in what a clone cannot carry, and leave the shared files alone |
| Either, when something stops working | `check-project.md`: read the state and report each check with its repair, changing nothing |

When the project matches none of the three, the checks alone say what is missing.

## What setup installs

`install.md` covers it: eight rules copied into `.agents/rules/`, two tools run in place, and two runtimes installed only when the project uses them (the glossary store, the issue listener). Every installable part lives under this skill; the other skills carry none.

## The field reference

The six custom fields setup declares, and every other field the set writes, are defined in `waymark`'s `res/fields.md`. Setup declares the names; that file says what they mean. A change to a field's name or type is a change in both places, and the project's `.waymark/config.toml` carries the third copy.

## Done

Setup is done when `check-project.md` reports every check as `ok` or `not applicable`.

## What setup does not do

- Install the skills. They are installed before setup runs.
- Create a remote, or commit. It ends with the list of files it changed.
- Repair a failing check on its own.

• SKILL.md 2 KB
• check-project.md 1 KB
• configure-project.md 6 KB
• install-glossary.md 10 KB
• install-issue.md 10 KB
• install.md 5 KB
• join-project.md 3 KB
• rules/rules-checklist.md 6 KB
• rules/rules-git.md 1 KB
• rules/rules-glossary.md 1 KB
• rules/rules-install.md 4 KB
• rules/rules-map.md 1 KB
• rules/rules-pending-communications.md 1 KB
• rules/rules-structure.md 2 KB
• rules/rules-task.md 2 KB
• tools/check-setup.mjs 28 KB
• tools/check-setup.test.mjs 4 KB
• tools/project-root-cli.cjs 1 KB
• tools/project-root-copies.test.cjs 2 KB
• tools/project-root.cjs 4 KB
• tools/project-root.test.cjs 11 KB
• tools/glossary/glossary.js 7 KB
• tools/glossary/package-lock.json 42 KB
• tools/glossary/package.json 1 KB
• tools/glossary/post-merge.sh 1 KB
• tools/glossary/project-root.cjs 4 KB
• tools/glossary/server.js 2 KB
• tools/glossary/tests/glossary.test.cjs 11 KB
• tools/issue/check-pending.mjs 3 KB
• tools/issue/configure.mjs 6 KB
• tools/issue/handles.toml.example 1 KB
• tools/issue/listener.mjs 18 KB
• tools/issue/lock.mjs 3 KB
• tools/issue/origin.mjs 1 KB
• tools/issue/package-lock.json 3 KB
• tools/issue/package.json 1 KB
• tools/issue/project-root.cjs 4 KB
• tools/issue/queue.mjs 1 KB
• tools/issue/service/linux.md 2 KB
• tools/issue/service/macos.md 3 KB
• tools/issue/service/windows.md 1 KB
• tools/issue/tests/test-catchup.mjs 13 KB
• tools/issue/tests/test-configure.mjs 5 KB
• tools/issue/tests/test-lock.mjs 3 KB
• tools/issue/tests/test-origin.mjs 2 KB
• tools/issue/tests/test-project-isolation.mjs 18 KB
• tools/issue/tests/test-security.mjs 22 KB