Install & Verify

Use this page when you want a working Node-based Glubean setup in a few minutes.

What you need

Node.js 22+
VS Code, Cursor, or another compatible editor

1. Install the Glubean skill

Glubean setup is skill-first. Give your coding agent the product guidance before asking it to install packages or write tests:


npx skills add glubean/skill

Then ask the agent:


Use the Glubean skill and set this project up.

The agent should inspect the repo, decide whether to create a separate Glubean verification project, and guide or apply the needed SDK, runner, CLI, MCP, and config changes.

2. Install the extension

Install the Glubean extension from the VS Code Marketplace or the VSIX releases .

After Node is available, the extension gives you the visual local layer: gutter runs, Test Explorer, environment switching, and result inspection. The same files still run through the CLI and MCP.

3. Initialize a project manually

Project init uses the glubean CLI through npx; you do not need a global install. For a runnable default project, use the non-interactive template:


npx glubean init --no-interactive

This scaffolds a Node project with package.json, project dependencies, tests/, contracts/, glubean.yaml, GLUBEAN.md, env files, and stable npm scripts for discover, doctor, sync, and upload.

The generated .env names the full non-secret Cloud configuration surface: GLUBEAN_PROJECT_ID, GLUBEAN_TARGET_ID, and GLUBEAN_API_URL. The gitignored .env.secrets contains the GLUBEAN_TOKEN placeholder.

Prefer doing this in a dedicated verification project when you are testing a real app end-to-end. Glubean is closer to an external API test workspace than to an app-local unit test runner.

Add MCP separately when an agent needs to run and inspect tests:


npx glubean config mcp

4. Run the generated checks

The default template installs its dependencies before init exits. Run the generated local profile:


npm test

That runs both generated raw test() checks and executable contracts. If dependency installation was interrupted, run npm install and retry npm test.

You can also inventory the generated assets immediately:


npm run discover

After Cloud project/token configuration is present, check readiness before the first publication:


npm run doctor

5. Verify the CLI entry

If you want to verify the CLI explicitly:


npx glubean --help