Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
Code-first custom fields, post types and taxonomies for WordPress. Schema in PHP, versioned in git — or built in the admin and exported to PHP.
Saved setup from 5 h ago
Will it work on Windows?
The maintainers included bin/install-wp-tests.sh. Run it from the cloned folder after reading it.
bash bin/install-wp-tests.sh
CONTRIBUTING.mdThanks for helping. Bug reports, fixes and documentation improvements are all welcome.
Requirements: PHP 8.2+, Composer 2, Node 24+ and, for integration tests, Docker.
git clone https://github.com/CtrlCheese/ctrlfield.git
cd ctrlfield
composer install
npm ci
npm run build # admin JS/CSS and the Gutenberg sidebar
Symlink or copy the folder into wp-content/plugins/ of a local site, or start one with npx wp-env start.
While working on the admin UI, npm run dev:admin rebuilds on every change.
Every pull request must pass the same checks as CI:
vendor/bin/phpunit # unit tests (core)
npm run test:js # Vitest
vendor/bin/phpstan analyse --memory-limit=1G
vendor/bin/phpcs # WordPress coding standards + security sniffs
Integration tests run against a real WordPress in wp-env. See .github/workflows/ci.yml.
declare(strict_types=1);, PSR-4 under src/.esc_html, esc_attr, esc_url, wp_kses_post).assets/admin/ctrlfield.js and ctrlfield.css are committed. Run npm run build before you commit changes to assets/admin/src/.docs/ and, when it affects users, the README in the same pull request.By contributing, you agree that your contribution is licensed under the GPL-2.0-or-later.
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: winget install Git.Git
git clone https://github.com/CtrlCheese/ctrlfield.git cd ctrlfield
Node.js 24, PHP >=8.2
winget install CoreyButler.NVMforWindows nvm install 24 nvm use 24 scoop install php composer # needs scoop: https://scoop.sh
npm ci composer install
No reports for Windows yet.
GitManual AI Agent reads the 7 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.