Documentation / Quickstart
WAYFORM DOCS / GET STARTED

Quickstart

Sign in, connect your coding agent, make your first plan, and build it from the Wayform app.

Before you start

Wayform currently requires approved access. Request access if you haven’t been set up yet. You need a Mac, a GitHub account, and at least one supported coding agent (Claude Code, Cursor, or Codex) installed and signed in.

Your team’s plans and decisions live in a Wayform space. A space can hold several projects. If you’re joining an existing team, ask its admin to invite your GitHub username.

1. Install the app and sign in

Use the macOS build supplied with your access setup. Move it into Applications and open it.

Choose Sign in with GitHub. The app completes sign-in in your browser and keeps its credential in the macOS credential store. There is no API key to paste.

If you’re starting a new team, name your space when asked. If you were invited, you join the team’s existing space.

2. Pick your agent and project folder

Open Settings, choose Claude Code, Cursor, or Codex, and map your Wayform project to the local folder of your product repo. The app runs the agent you already have; it doesn’t supply a hosted model or replace your agent subscription.

3. Make your first plan

Start a new chat and 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 gets a brief of the team’s relevant decisions, reads the repo, and saves a numbered, versioned plan. Review it and move it to active when it’s right. Learn the plan workflow.

4. Build it

Open the plan and choose Build. The build runs in a build chat in the app, on its own branch, with your picked agent. Approve actions as they come up, or turn on Auto for Claude Code or Cursor. Builds in the app.

5. Check the round-trip

Ask your agent to record a small decision, including why you made it. Open a fresh chat and confirm the agent can find it. You can also see it in the app’s Memory view.

Optional: use Wayform from your terminal too

To bring the same plans, decisions, and guard into Claude Code, Cursor, or Codex sessions you start yourself, install the CLI and initialize your product repo:

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

Choose the clients you actually use (claude, cursor, codex). Setup writes project-scoped configuration and hooks with no credentials in them. Connect your agents.

Optional: mirror to GitHub

Wayform’s hosted ledger is the source of truth, so you don’t need a repo to start. If you want a git copy you own, create a private GitHub repository with a first commit and select only that repo when you install the Wayform GitHub App. Wayform mirrors new entries there as append-only commits. Data and access.

Reviewed against the product on .
Source: Wayform README.md; gateway/README.md; app/src-tauri (native sign-in, build sessions); shipped plans #53, #56, #58