Glubean Cookbook

Ask Glubean AI anything — setup help, feature questions, comparisons

Runnable pattern recipes for Glubean. For full documentation, visit docs.glubean.com.

Two workflows, two packages

This monorepo contains two independent cookbook packages. Pick the one that matches how you work:

test-after/ — Explore and verify existing APIs

Write tests against live APIs. You explore endpoints, assert on responses, and build up a test suite over time.

cd test-after && pnpm install
glubean run --profile public                     # all no-secret suites
glubean run --profile public --suite dummyjson   # narrow to one suite

Suites (one per topic) and run profiles (public / secrets / all / smoke) are declared in test-after/glubean.yaml — the canonical way to organize a Glubean project. The worked examples live in test-after/tests/; test-after/explore/ is your scratchpad for work-in-progress drafts.

Best for: learning Glubean, testing existing APIs, exploratory testing, CI regression suites.

contract-first/ — Declare API behavior upfront

Define contracts that describe what your API should do. Glubean validates the live API against your declarations.

cd contract-first && pnpm install
glubean run --profile public                 # validate the public domains
glubean run --profile all --suite dummyjson  # one domain

Contract domains are suites in contract-first/glubean.yaml; glubean contracts projects them to Markdown / JSON / OpenAPI.

Best for: API design reviews, spec-driven development, generating documentation from intent.

Setup

git clone https://github.com/glubean/cookbook
cd cookbook
pnpm install      # installs both packages (the @glubean/* libraries)
npm i -g glubean  # the CLI tool, installed separately (or use `npx glubean`)

A project depends on the @glubean/* libraries its test code imports (@glubean/sdk, @glubean/runner, and any plugins like @glubean/graphql), not on the glubean CLI package — that's a tool you run (glubean / npx glubean), not a library you depend on.

Run the cookbook

pnpm run check        # TypeScript checks for both packages
pnpm run test:public  # public examples only, no secrets required
pnpm run test:secrets # examples that intentionally require real secrets
pnpm test             # check + public + secret-backed examples

The secret-backed examples are not optionalized or silently skipped. They are expected to fail fast when required credentials are missing.

Create test-after/.env.secrets from the template when you want to run them:

cp test-after/.env.secrets.example test-after/.env.secrets

test-after/.env.secrets is gitignored and must stay local. The template maps host environment variables into the cookbook's secret names:

All three run via pnpm run test:secrets (the secrets profile); narrow to one with --suite:

Suite (glubean run --profile secrets --suite <name>)	Required secrets
github-advanced	GITHUB_TOKEN
ai-contracts	OPENAI_API_KEY
stripe	STRIPE_SECRET_KEY, SMEE_URL

AI Tools (optional, recommended)

npx glubean@latest config mcp      # AI can discover, run, and diagnose tests
npx skills add glubean/skill       # AI learns glubean patterns to write tests

Learn more

• Documentation
• VS Code Extension
• SDK Reference