Quickstart

Before you start

Wayform currently requires approved access. Request access if you haven’t been set up yet. Have GitHub, Node.js 18 or later, and a supported coding agent installed. The desktop app runs on macOS.

There are two repositories in a typical setup:

• Your product repo: the code you work on, where you run Wayform setup.
• Your memory repo: a separate private GitHub repo that stores your team’s plans and decisions.

If you’re joining an existing space, your admin should invite your GitHub username. Use the team’s existing memory repo.

1. Create your memory repo

For a new space, create a private GitHub repository and give it a first commit. For example, yourteam-memory. This is the source of truth for your plans and decisions.

The GitHub owner or organization must be approved for access before the space can activate.

2. Install and initialize

Install the CLI, then run setup from your product repository:

npm install -g wayform
cd /path/to/your-product
wayform init --remote --clients cursor,claude

Choose the clients you actually use. Supported setup identifiers include claude, cursor, and codex. For Codex alone:

wayform init --remote --clients codex

Setup writes project configuration and installs the relevant hooks and skills. Keep configuration project-scoped so the team’s context belongs to this codebase.

3. Connect GitHub

Connect the Wayform MCP server from your coding client and sign in with GitHub. Follow the GitHub App setup, selecting only the private memory repo you created above. Don’t select your product repo as the memory store.

Your client authenticates through OAuth. There is no API key to paste into project files.

For hooks on this machine, also run:

wayform login

4. Check your setup

wayform doctor

Resolve failed checks before relying on context injection. Start a new coding session after authentication so its startup hooks can run.

Ask your agent to record a small decision, including why you made it. Open a fresh session and confirm that the context is available. Your memory repo should contain a corresponding commit.

5. Open the desktop app

Use the macOS build supplied with your access setup. Install the CLI and complete wayform login first; the desktop app reuses that login.

Choose your agent in Settings and map the project to its local repo folder. Then start a planning chat. Desktop setup and shortcuts.

6. Make your first plan

Try a request like:

Plan team invitations for this project. Use the decisions we’ve already made and check what’s in the repo first.

The agent obtains a brief, writes the plan, and saves it as a numbered, versioned document. Review the plan before moving it to active.

To build an agreed plan from your product repository:

wayform build 12 --client claude

Replace 12 with your plan number. You can also select cursor or codex. Learn the plan workflow.