Getting started

This guide takes you from nothing to a working trial environment. It assumes no prior setup beyond a GitHub repository and an account.

Before you start

You need three things:

  • A GitHub repository. Specifications are committed here. It can be private; the platform uses a GitHub App, so you never paste a personal access token.
  • An account. The platform reads your GitHub identity, so signing in with GitHub is the fastest route.
  • One behaviour worth specifying. Not a whole application — one behaviour, with a clear expected outcome.

That last point matters more than it looks. A large first specification will produce a large first draft, and reviewing a large draft is exactly the work you are trying to avoid. Start with something where you can say, without hesitation, what the correct behaviour is.

A good candidate: a validation rule, a state transition, a pricing calculation, an error path, or an authorisation check.

The path

Describe it. One sentence is enough to start. "A customer can cancel a subscription before the renewal date and gets a prorated refund." The model will draft the specification from that, and mark everything it inferred rather than read from you.

Review the draft. You get a diff, clause by clause. Approve what is right, reject what is wrong, and tell it why in a sentence. See review and approve.

Approve and build. Approval freezes a snapshot. The build runs the four verification layers. See run a trial.

Use the environment. A live instance with seeded data, deployed near you. Break it on purpose. See run a trial.

What success looks like

The question the platform is trying to answer is narrow and measurable: did reviewing the spec take less time than reviewing the equivalent code would have?

That is the number we track, and it is the number you should track. If the spec review is not faster than the code review it replaces, the platform is not earning its place, no matter how good the generated code is.

If you find yourself reviewing a large spec slowly, that is usually a signal about scope, not about the platform: split the specification until each review fits in one sitting.

Next