webentor-setup

Shared setup runtime and thin CLI for Webentor starter/reference projects.

Runtime Contract

Projects consume this repository via git subtree into scripts/setup-core/.

setup-core is git-managed runtime code. Do not place project-specific edits inside this folder. Use project-owned extension points instead:

• scripts/.env.setup
• scripts/hooks/
• scripts/project-specific/

OS Script Layout

OS-specific setup scripts live under dedicated folders:

• scripts/setup-core/win/ for Windows-specific runtime steps
• scripts/setup-core/mac/ for macOS-specific runtime steps

Hook API

Supported hook names:

• pre-env
• post-env
• pre-composer
• post-composer
• pre-deps
• post-deps
• pre-wp-setup
• post-wp-setup
• pre-db-sync
• post-db-sync
• custom-steps

Hooks can be placed in:

• scripts/hooks/<hook>.sh
• scripts/hooks/<hook>.d/*.sh
• scripts/project-specific/<hook>.sh

Function Override API

Projects can override selected helper steps without patching setup-core.

• Add scripts/project-specific/functions.sh
• Define one or more *_override functions to replace default steps:
  • setup_composer_override()
  • setup_deps_override()
  • setup_wp_override()
  • sync_db_override()
• If an override is not defined, setup falls back to the core implementation automatically

CLI

# Interactive mode — prompts for project slug, 1Password, DB sync, Typesense:
bin/webentor-setup init

# Non-interactive — all flags provided, no prompts shown:
bin/webentor-setup init --project my-project --with-1password false --with-db-sync true --with-typesense false

# Flags are optional overrides; omitted options are prompted interactively.
bin/webentor-setup doctor --cwd /path/to/project

Upgrades

Sync the shared setup runtime (scripts/setup-core) from a tagged webentor-setup release via git subtree pull — see the Starter Upgrades guide.

Mechanical code changes to consumer theme code (PHP/TS/CSS/JSON) required by a webentor-core update are handled by @webikon/webentor-codemods, not by this CLI.