Quickstart

Install Bazable and generate your first contract in under five minutes.

1. Install the CLI

npm

npm install -g bazable

Verify the install:

bazable --version

For Postman-based testing with bazable test --newman or bazable serve --verify, optionally install Newman globally: npm install -g newman. If it’s not installed, Bazable falls back to npx newman. See Postman Integration for the full workflow.

2. Initialize a project

From the root of your app, create a bazable.config.json:

bazable init

This reads your package.json for the project name and seeds an empty endpoints list. See bazable init for details.

3. Extract endpoints from your code

Scan the codebase to auto-populate the contract with real endpoints and payload schemas:

bazable extract -r

Use a preset for non-JS stacks:

bazable extract -s py    # Python
bazable extract -s go    # Go
bazable extract -s rb    # Ruby

Full options in bazable extract.

4. Validate code against the contract

bazable inspect

inspect flags dead URLs, payload mismatches, and over-fetching. Run it locally, in a pre-push hook, or in CI.

5. Generate code and mocks

Backend stubs

Generate Express or Hono routes with Zod validation from your contract.

UI forms

Generate React + Tailwind form components from request schemas.

Mock server

Spin up a mock API with realistic data generation.

Local dashboard

Browse endpoints, schemas, and test your API in the browser.

6. Sync with your team

Push the contract to Bazable Cloud so teammates can pull it:

bazable push
bazable sync

Authenticate the CLI with device code login.

What’s next

• Explore the full command reference.
• Try the frontend and backend cheat sheets.
• Let AI agents propose schema changes with bazable propose or hook them into your IDE with bazable mcp.