Skip to main content
Gutenbridge

Start in your project

Getting started

Use the local CLI to set up a project, see what the supported surface includes, and create a client you can use in your app.

What you need

  • Node.js 24 LTS.
  • A project folder where gutenbridge.config.js and .env.example do not already exist.
  • Network access to Gutenbridge; paid generation also needs access to your WordPress site.
  • For paid generation, a WordPress site with its REST API enabled and local credentials for routes that need them.

Try the Free starter

Free is anonymous. It gives you the same generic, read-only WordPress Core client without a site-specific build.

  1. 1. Create a project

    mkdir my-gutenbridge-project
cd my-gutenbridge-project
npx gutenbridge init

  2. 2. Create your local environment file

    cp .env.example .env
# Leave GUTENBRIDGE_API_KEY empty for Free.

  3. 3. Generate the starter

    npx gutenbridge generate

Free fetches an anonymous static Gutenbridge bundle. It does not contact WordPress, upload site schema, or need your WordPress URL or credentials. It does need network access to download the bundle.

Pro and Agency create a client from supported API evidence discovered by the CLI on your machine.

  1. 1. Set up paid access

    Create an account and paid subscription, then make an API key in the dashboard. The full key is shown once.

    Create account

  2. 2. Add your local configuration

    npx gutenbridge init
cp .env.example .env
    GUTENBRIDGE_API_KEY=paste_your_key_here
WORDPRESS_SITE_URL=https://your-site.example
WP_USERNAME=your-wordpress-username
WP_PASSWORD=your-wordpress-password
WOOCOMMERCE_CONSUMER_KEY=your-woocommerce-consumer-key
WOOCOMMERCE_CONSUMER_SECRET=your-woocommerce-consumer-secret

    Add WooCommerce credentials only when the selected modules need them. Keep .env private; the scaffolded .gitignore excludes it.

  3. 3. Discover and generate

    npx gutenbridge generate

    The CLI checks the site and asks you to confirm before it sends schema evidence. Choose the modules you want to generate.

What the paid run sends

The Gutenbridge API key goes to Laravel for authentication. The CLI also sends selected modules, site schema evidence needed for generation, and a project URL identifier.

WordPress and WooCommerce credentials, cookies, nonces, site authorization headers, and other .env values stay on this machine.

After generation

Use your client in the app

Generated files are written under .gutenbridge/. Import createClient(config) from .gutenbridge/client.ts and provide the WordPress base URL your application should call. The generated client talks directly to WordPress at runtime.

Compare Free, Pro, and AgencyReview supported functionality