wp-typia
v0.24.4
Published
Canonical CLI package for wp-typia scaffolding and project workflows
Maintainers
Readme
wp-typia
Canonical CLI package for wp-typia.
Use this package for new projects:
npx wp-typia create my-blockbunx wp-typia create my-blockcurl -fsSL https://github.com/imjlk/wp-typia/releases/latest/download/install-wp-typia.sh | shnpx wp-typia create my-plugin --template workspacenpx wp-typia create my-plugin --template workspace --profile plugin-qanpx wp-typia create my-books --template query-loop --query-post-type book
Extend an existing workspace with:
wp-typia add block counter-card --template basicwp-typia add integration-env local-smoke --wp-env --release-zip --service docker-composewp-typia add style callout-emphasis --block counter-cardwp-typia add transform quote-to-counter --from core/quote --to counter-cardwp-typia add binding-source hero-datawp-typia add binding-source hero-data --block counter-card --attribute headlinewp-typia add rest-resource snapshots --namespace my-plugin/v1 --methods list,read,createwp-typia add rest-resource snapshots --namespace my-plugin/v1 --methods read,update --route-pattern '/snapshots/(?P<id>[\d]+)' --permission-callback my_plugin_can_manage_snapshotswp-typia add rest-resource external-record --manual --namespace legacy/v1 --method GET --auth authenticated --path '/records/(?P<id>[\d]+)'wp-typia add rest-resource integration-settings --manual --namespace my-plugin/v1 --method POST --secret-field apiKeywp-typia add post-meta integration-state --post-type post --type IntegrationStateMetawp-typia add ability review-workflowwp-typia add ai-feature brief-suggestions --namespace my-plugin/v1wp-typia add editor-plugin review-workflow --slot sidebarwp-typia add editor-plugin seo-notes --slot document-setting-panelwp-typia add hooked-block counter-card --anchor core/post-content --position after
wp-typia <project-dir> remains available as a backward-compatible alias to
wp-typia create <project-dir> when <project-dir> is the only positional
argument.
Configuration files:
wp-typialoads~/.config/wp-typia/config.json,.wp-typiarc,.wp-typiarc.json, thenpackage.json#wp-typia; later sources override earlier sources--config <path>is an explicit override loaded after the default sources, relative to the current working directory unless absolute- config files use a strict schema: unknown keys are errors rather than warnings or stripped values, so typos fail near the source config file
- object values are deep-merged, while arrays such as
mcp.schemaSourcesreplace earlier arrays instead of concatenating - projects can declare block API compatibility intent with
wordpress.minVersion,wordpress.testedVersions,compatibility.strict, andcompatibility.allowUnknownFutureKeys; future Supports, Variations, and Bindings helpers use those values for version-aware diagnostics
Compatibility notes:
@wp-typia/project-toolsis the canonical programmatic project orchestration package- the published CLI now ships built
dist-bunliruntimes, and the canonical Node bin uses a Node-safe fallback runtime for non-TUIcreate/add/migrate,doctor,sync,--version,--help, and template inspection without requiring a locally installed Bun binary - if
wp-typia --helpsaysRuntime: Node fallback, you are on that Bun-free path. You get human-readable help/output, common non-interactive project workflows, and lighter prompt behavior where interactive fallback is still supported - when you request machine-readable output with
--format json, CLI failures now include a stableerror.codefield so wrappers and CI can branch without parsing English text - the stable machine-handled branching key is
error.code. Structured context likeerror.command,error.kind, anderror.tagmay also be useful to consumers, while free-form text likeerror.message,error.summary, anderror.detailLinesstays human-facing guidance and can evolve without notice - when that Node fallback prompts interactively, it intentionally stays lighter than the Bun/OpenTUI flow: numbered lists, option label/value matching, inline validation retries, and redraw commands for the current choices:
?for the short reprint shortcut,helpfor the explicit redraw command, andlistfor users who expect option listing semantics - Bunli-specific command surfaces such as
skills,completions, andmcpstill run through the builtdist-bunli/cli.jsartifact and require Bun when you use the npm package directly; if you want the full Bunli/OpenTUI runtime story without a local Bun install, prefer the standalone installer from the latest GitHub Release - standalone release assets are published per platform together with checksum manifests and install scripts:
install-wp-typia.shfor macOS/Linux andinstall-wp-typia.ps1for Windows - internal runtime-bridge helper modules are implementation details; integrations
should target the CLI or
@wp-typia/project-tools, not CLI internals
Maintainers: see docs/bunli-cli-migration.md
for the active CLI ownership contract and the staged Bunli cutover plan.
Project meta docs:
