CLI Reference

Complete command-line interface reference for webMCP. Process, validate, and optimize web content for AI consumption with powerful CLI tools. Now includes React components, WordPress plugin integration, and multi-platform deployment options.

Installation

npm install -g @webmcp/cli
npm install @webmcp/react
npx @webmcp/cli --help
webmcp --version

Available Commands

Complete reference for all webMCP CLI commands

webmcp scan

Scan HTML files or URLs to generate webMCP configurations

Syntax

webmcp scan <input> [options]

Options

OptionTypeDefaultDescription
--output, -ostringautoOutput file for webMCP configuration
--format, -fstringwmcpOutput format (json or wmcp)
--urlstringPage URL for context metadata
--verbosebooleanfalseEnable detailed output

Examples

webmcp scan login.html --output login.wmcp --verbose
webmcp scan https://example.com/signup --format json --output signup.json
webmcp scan form.html --url https://mysite.com/contact --verbose

webmcp validate

Validate webMCP configuration files against schema and best practices

Syntax

webmcp validate <file> [options]

Options

OptionTypeDefaultDescription
--schemastring0.2Schema version to validate against
--strictbooleanfalseEnable strict validation mode
--jsonbooleanfalseOutput results in JSON format

Examples

webmcp validate page.wmcp
webmcp validate page.wmcp --schema 0.2 --strict
webmcp validate page.wmcp --json > validation-report.json

webmcp optimize

Optimize webMCP configurations for AI model consumption

Syntax

webmcp optimize <file> [options]

Options

OptionTypeDefaultDescription
--target, -tstringgpt-4oTarget AI model
--level, -lstringadvancedCompression level
--output, -ostringOutput file for optimization
--goalstringGoal description for AI prompt

Examples

webmcp optimize page.wmcp --target gpt-4o --level advanced
webmcp optimize login.wmcp --goal "Login with username and password" --output login-prompt.txt
webmcp optimize form.wmcp --target claude-3.5-sonnet --level premium --output optimized-form.json

webmcp lint

Lint webMCP files for best practices and code quality

Syntax

webmcp lint <pattern> [options]

Options

OptionTypeDefaultDescription
--fixbooleanfalseAutomatically fix issues where possible
--configstringCustom linter configuration file

Examples

webmcp lint page.wmcp
webmcp lint "src/**/*.wmcp" --fix
webmcp lint "*.wmcp" --config .webmcp-lint.json

webmcp dev-server

alias: dev

Start development server with webMCP processing capabilities

Syntax

webmcp dev-server [options]

Options

OptionTypeDefaultDescription
--port, -pnumber3000Server port
--watchbooleanfalseWatch for file changes
--openbooleanfalseOpen browser automatically

Examples

webmcp dev-server
webmcp dev-server --port 8080 --open
webmcp dev-server --watch

webmcp benchmark

Premium

Benchmark webMCP performance across AI models (Premium feature)

Syntax

webmcp benchmark <file> [options]

Options

OptionTypeDefaultDescription
--modelsstringgpt-4o,claude-3.5-sonnetModels to test (comma-separated)
--iterationsnumber10Number of test iterations
--detailedbooleanfalseShow detailed metrics

Examples

webmcp benchmark page.wmcp
webmcp benchmark page.wmcp --models gpt-4o,claude-3.5-sonnet,gpt-4 --iterations 100
webmcp benchmark page.wmcp --detailed

webmcp react

Generate React components with webMCP optimization

Syntax

webmcp react <component-name> [options]

Options

OptionTypeDefaultDescription
--typestringformComponent type (form, input, button)
--outputstring./Output directory
--typescriptbooleantrueGenerate TypeScript component

Examples

webmcp react ContactForm --type form
webmcp react SmartInput --type input --output ./components
webmcp react OptimizedButton --typescript

webmcp wordpress

Generate WordPress plugin files and configurations

Syntax

webmcp wordpress <plugin-name> [options]

Options

OptionTypeDefaultDescription
--formsstringcf7,gravity,wpformsForm plugins to integrate
--outputstring./wp-pluginPlugin output directory
--premiumbooleanfalseInclude premium features

Examples

webmcp wordpress webmcp-optimizer
webmcp wordpress my-plugin --forms cf7,wpforms --premium
webmcp wordpress site-optimizer --output ./plugins

Supported AI Models

gpt-4o
gpt-4
gpt-3.5-turbo
claude-3.5-sonnet
claude-3-haiku
claude-3-opus
gemini-pro
gemini-pro-vision
gemini-1.5-pro
gemini-1.5-flash

Compression Levels

basic

30-40%

Simple element filtering (free)

advanced

50-70%

Context-aware optimization (free)

premium

70-85%

Model-specific tuning (premium)

Environment Variables

DEBUGfalse

Enable debug logging

WEBMCP_API_KEYunset

API key for premium features

WEBMCP_CACHE_DIR~/.webmcp/cache

Cache directory location

Global Options

--help, -h

Show command help

--version, -V

Show version number

Performance Characteristics

HTML Scanning:~100ms for 1,000 elements
Validation:~10ms average
Optimization:~50ms average
Linting:~25ms average

Troubleshooting

Common issues and solutions

File Not Found

ls -la page.wmcp
chmod 644 page.wmcp
webmcp validate ./page.wmcp

Invalid JSON

cat page.wmcp | jq .
# or
python -m json.tool page.wmcp

Port Already in Use

lsof -ti:3000 | xargs kill -9
# or use different port
webmcp dev-server --port 8080

Permission Denied

chmod 755 /usr/local/bin/webmcp
# or reinstall globally
npm install -g @webmcp/cli --force