fluent-wp-client-cli

fluent-wp-client CLI

The fluent-wp-client CLI connects to a live WordPress site, discovers its REST API schemas, and generates requested code artifacts — Zod validators, JSON Schema, or TypeScript declarations — for use in downstream apps, validators, and AI tooling.

Command

npx fluent-wp-client schemas   # Zod TypeScript output by default
npx fluent-wp-client --help

schemas command

Generates normalized schemas for every discovered WordPress resource (post types, taxonomies). Output paths define which artifacts are written. If no output path is provided, the CLI writes wp-schemas.ts.

Basic usage

# Zod output (default)
npx fluent-wp-client schemas --url https://example.com

# JSON Schema only
npx fluent-wp-client schemas --url https://example.com \
  --json-out src/lib/wp-schemas.json

# Multiple artifacts with custom filenames
npx fluent-wp-client schemas --url https://example.com \
  --zod-out src/lib/wp-schemas.ts \
  --json-out src/lib/wp-schemas.json \
  --types-out src/lib/wp-types.d.ts

Generated output example

For each resource the Zod output produces:

// JSON Schema literal — portable, usable outside Zod
export const wpBookJsonSchema = { type: "object", properties: { ... } } as const;

// Zod schema built from the JSON Schema
export const wpBookSchema = z.fromJSONSchema(wpBookJsonSchema);

// Inferred TypeScript type
export type WPBook = z.infer<typeof wpBookSchema>;

Authentication

Authenticated discovery is required to access write schemas (create/update). Pass one auth flag — do not combine multiple auth modes in the same invocation.

# Application password
npx fluent-wp-client schemas --url https://example.com \
  --username admin \
  --password "xxxx xxxx xxxx xxxx"

# JWT token
npx fluent-wp-client schemas --url https://example.com \
  --token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

# Pre-built Authorization header
npx fluent-wp-client schemas --url https://example.com \
  --auth-header "Bearer eyJhbG..."

Flag	Auth mode
--username + --password	Application password (Basic auth)
--token	JWT bearer token
--auth-header	Prebuilt header value

Resource filtering

Use --include or --exclude to limit which resources are generated. Values are comma-separated slugs or REST bases.

# Only generate posts and books
npx fluent-wp-client schemas --url https://example.com --include posts,books

# Generate everything except users and settings
npx fluent-wp-client schemas --url https://example.com --exclude users,settings

# Combine: include posts,books,genre then remove posts
npx fluent-wp-client schemas --url https://example.com --include posts,books,genre --exclude posts

Interactive mode

Omit --url to enter interactive mode. The CLI prompts for the site URL and authentication method.

npx fluent-wp-client schemas

All flags reference

Flag	Default	Description
--url <url>	— (prompts)	WordPress site URL
--out <file>	wp-schemas.ts	Alias for --zod-out; accepts .ts or .mjs
--zod-out <file>	wp-schemas.ts	Zod module output path; accepts .ts or .mjs
--json-out <file>	—	JSON Schema output path; must end in .json
--types-out <file>	—	TypeScript declaration output path; must end in .d.ts
--username <name>	—	Application password username
--password <value>	—	Application password
--token <value>	—	JWT bearer token
--auth-header <value>	—	Prebuilt Authorization header value
--include <list>	all	Comma-separated resource slugs/REST bases to include
--exclude <list>	none	Comma-separated resource slugs/REST bases to exclude

CI / build integration

For deterministic builds, pin the URL, auth, and output paths as flags so the CLI runs non-interactively. The command exits with a non-zero code on failure.

npx fluent-wp-client schemas \
  --url "$WP_URL" \
  --username "$WP_USER" \
  --password "$WP_APP_PASSWORD" \
  --zod-out src/lib/wp-schemas.ts \
  --json-out src/lib/wp-schemas.json \
  --types-out src/lib/wp-types.d.ts

Using generated schemas with the client

After generating, import and pass schemas to the fluent-wp-client runtime client to validate read/write responses.

import { WordPressClient } from 'fluent-wp-client';
import { wpBookSchema } from './wp-schemas';

const wp = new WordPressClient({ baseUrl: 'https://example.com' });

// Pass as a response schema for CRUD operations
const book = await wp.content('books').item(7);
const parsed = wpBookSchema.parse(book);

CLI vs runtime discovery

	CLI (build-time)	Runtime .describe() / .explore()
When schemas are fetched	During build / CI run	At application runtime
Output	Generated .ts / .json files	Live API response objects
Best for	Static typing, Zod validators, AI tools	Dynamic sites, plugin discovery
Auth	Flags passed to CLI	WordPressClient configuration

For runtime schema discovery, see the schema-discovery.mdx reference in the fluent-wp-client skill.