Backdrop CMS

@webship.co/workspace-backdrop-cms 1.0.7 · github.com/webship/workspace-backdrop-cms · npm

Backdrop CMS for the Webship Workspace dashboard: a builder that makes a real Backdrop CMS site in a container, a Bee tool for the sites it built (Bee is the command line tool of Backdrop CMS), the default accounts, the Backdrop CMS step pack wired into the workspace's testing setup, and two AI agents that know all of it.

The workspace is container-based (DDEV by default): a Backdrop CMS project is a row like any other, so the row menus the core draws (start, stop, launch, backup, clone, remove, tests) work on it unchanged.

It is made from the reference platform plugin, @webship.co/workspace-wordpress.

Use it

cd ~/workspace
bash core/scripts/plugins.sh --require github:webship/workspace-backdrop-cms   # npm install into the dashboard
bash core/scripts/plugins.sh --activate backdrop-cms                            # plugins.backdrop-cms in settings.yml
bash core/scripts/plugins.sh --install backdrop-cms                             # commands, functions, args, agents
bash core/scripts/plugins.sh --configure backdrop-cms                           # nothing to configure: it has no settings file

The same four steps are buttons on the dashboard's Settings → Plugins page. --install is idempotent. --uninstall removes what it placed; an agent you edited stays.

The commands land in the sites folders that are in the workspace (dev, test, sandboxes, demos); the agents land in the AI Agents folder (ai-agents/) when the workspace has one, and are installed into ~/.claude/agents from there like any other agent.

It needs a Webship Workspace 1.0.7 or later.

What the package holds

Path	What it is
`commands/cmd-backdrop-cms-project.sh`	The builder, in the Build list as Backdrop CMS (latest 1.x), installed into every sites folder
`commands/cmd-tools-backdrop-cms-cli.sh`	Bee for one project: what the site is, a command, updates, caches, cron, the default accounts
`scripts/functions/fun-backdrop-cms.sh`	The bash functions behind both, sourced by bootstrap once installed; the names the core's tools look for (`set_backdrop_users`, `add_backdrop_users`, `cancel_backdrop_users`, `testing_configure_backdrop`, named after the DDEV project type `backdrop`)
`scripts/args/arg-backdrop-cms.sh`, `arg-backdrop-cms-cli.sh`	Their argparse; the Build form draws the builder's flags from the first
`testing/site.feature`	The first feature a Backdrop CMS project gets when testing is set up
`agents/backdrop-cms-site-builder.md`	The agent that builds and maintains Backdrop CMS sites with these commands
`agents/backdrop-cms-tester.md`	The agent that writes and runs scenarios with the Backdrop CMS step pack
`src/index.ts`	`register(api)`: what the assistant is told about Backdrop CMS here
`features/backdrop-cms.feature`	Scenarios for the dashboard's own browser suite

The workspacePlugin block in package.json is the manifest the installer reads.

The commands

Run them from a sites folder. --help is safe on both.

Build a site

cd ~/workspace/dev
bash cmd-backdrop-cms-project.sh mysite --install --add-users

Flag	What it does
`--version <x>`	The release to download: `latest` (the default: the current stable release), or a number such as `1.32.0`
`--install`	Install the site, with the workspace account as its administrator
`--add-users`	With `--install`: add the default accounts, one per role
`--profile <name>`	The install profile: `standard` (the default) or `minimal`
`--php-version <x>`	The PHP of the project container (`8.3`)
`--launch`	Open the site when it is ready

The site answers at https://mysite.ddev.site; log in at /user/login. The build runs ddev config --project-type=backdrop with the Node.js of the workspace (24), adds Bee to the container with its add-on (backdrop-ops/ddev-backdrop-bee), downloads the release with Bee and installs the site with bee site-install. The container tool writes settings.ddev.php for the database, and the installer is given the same container values (db / db / db): nothing personal is written. Cron runs once at the end, so the search has an index. A project of the same name is deleted first.

Bee asks for the current release with a question that has an hourly limit for an address. When it is refused, the build fetches the package of the latest release instead and goes on.

Work on a site

bash cmd-tools-backdrop-cms-cli.sh mysite                                    # version, address, status, accounts
bash cmd-tools-backdrop-cms-cli.sh mysite --run "projects --type=module"
bash cmd-tools-backdrop-cms-cli.sh mysite --run "help"                       # every command of Bee
bash cmd-tools-backdrop-cms-cli.sh mysite --flush                            # flush every cache
bash cmd-tools-backdrop-cms-cli.sh mysite --cron                             # run cron once
bash cmd-tools-backdrop-cms-cli.sh mysite --update                           # core and modules, database updates, caches
bash cmd-tools-backdrop-cms-cli.sh mysite --add-users                        # the default accounts
bash cmd-tools-backdrop-cms-cli.sh mysite --cancel-users                     # delete them

The default accounts

Account	Role	Handle in the tests
`administrator`	Administrator	`admin`
`editor`	Editor	`editor`
`member`	none beyond Authenticated	`member`

Each has the address <account>@example.com and the password of the workspace's other default lists. They are for local sites and for tests; the site's own administrator is the workspace account and is never written into a test. The row's Users menu (Add the test users), bash cmd-tools-add-users.sh mysite backdrop and bash cmd-tools-cancel-users.sh mysite backdrop add and remove the same list: it is named backdrop, after the DDEV project type.

Test a site

bash cmd-tools-testing.sh mysite                 # webship-js, the step pack, the users registry, a first feature
bash cmd-tools-testing.sh mysite --run           # run the suite in the container
bash cmd-tools-testing.sh mysite --run --path tests/features/site.feature

cmd-tools-testing.sh is the workspace's own. For a Backdrop CMS project it also adds @webship-js/backdrop-cms-steps to package.json, lists its step definitions in cucumber.js after webship-js's own, writes the users registry (the handles above, overridable with SITE_<HANDLE>_USER and SITE_<HANDLE>_PASSWORD), places tests/features/site.feature when the project has none, and makes sure the default accounts are on the site. Run it again and it adds what is missing and keeps what you changed.

The agents

Agent	Use it to
`backdrop-cms-site-builder`	Build, update, maintain or remove a Backdrop CMS site with the commands above, in containers only
`backdrop-cms-tester`	Set the testing stack up, look at the site in the Playwright MCP browser first, write scenarios from the pack's steps and run them; it never creates an account in a suite and never writes a platform name into a step phrase

After --install they are in the AI Agents folder of the dashboard; Install there puts one into ~/.claude/agents, or from the command line:

cd ~/workspace/ai-agents
bash cmd-tools-ai-items.sh backdrop-cms-tester --install

Develop it

npm install     # builds dist/ (TypeScript)
npm run lint
npm test        # the manifest, the commands, the agents, the functions against a scaffolded project