Start Here

Agent first

This is the default workflow. Your IDE coding agent has source context, so it can set up the verification project, write contracts, run checks, inspect structured failures, and repair the source.

1. Install the Glubean skill:

   npx skills add glubean/skill

2. Tell your agent:

   Use the Glubean skill and set up a verification project.

3. Let the agent inspect your app repo and decide whether to create a separate Glubean project or reuse an existing one.

4. Let the agent guide or apply SDK, runner, CLI, MCP, and config setup.

5. Let the agent write the first small contract, workflow, or raw test().

6. Run locally through MCP or npx glubean run.

7. Upload the run to a Target when the evidence is useful to the team.

Read IDE & Local, then Run Your First Check.

Glubean is end-to-end verification, so a dedicated verification project is often the right shape. Treat it like an API test workspace that targets your real app, not like unit tests embedded in a Vite/Jest/Vitest app.

Human/manual

Use this lane when you want to set up Glubean yourself without an agent driving the first pass. The default non-interactive template targets a public demo API, so you can run it before wiring your own service.

1. Create and initialize a runnable project with the CLI:

   mkdir my-api-tests
   cd my-api-tests
   npx glubean init --no-interactive

   The template adds the project dependencies it needs, including the Glubean SDK, runner, and local CLI.

2. Run the generated test suite:

   npm test

   init installs the template dependencies before it exits. If installation was interrupted, run npm install and then retry npm test.

You can also call the CLI directly through npx:

npx glubean run --profile local
npx glubean ci run

Use the cookbook when you want runnable examples to copy from:

github.com/glubean/cookbook 

Read Install & Verify, then CLI & Config.