cf-node-bootstrap/cf-apps/README.md
pyr0ball 2a325b55bd feat: interactive CF Apps install menu with oem/collaborator/orchard profiles
Adds a manifest-driven "Install CircuitForge Apps" menu to install.sh,
alongside the existing extras-menu pattern.

- cf-apps/*.manifest: one file per product (circuitforge-core, peregrine,
  kiwi, snipe, turnstone, pagepiper, linnet - the beta/alpha menagerie
  products), declaring repo URLs, supported install types, conda env,
  .env template, and per-install-type setup hooks. Hooks prefer shelling
  out to each product's own install.sh/Makefile/docker-compose rather
  than reimplementing their setup logic.
- lib/cf-apps.functions: registry loader, provisioning-profile prompt
  (oem/collaborator/orchard), app multiselect menu, and the install
  dispatcher (clone, .env bootstrap, install-type selection, hook
  dispatch). circuitforge-core installs automatically as a dependency
  for apps that declare app_needs_core=true.

Provisioning profiles gate both which apps are offered and which remote
credentials are used:
- oem: public CircuitForgeLLC GitHub mirrors only, no Forgejo access,
  no circuitforge-orch (product install menu only)
- collaborator: private Circuit-Forge Forgejo, same product menu
- orchard: narrow flow, not the product menu - clones circuitforge-orch
  (Forgejo-only, no public mirror exists) and hands off interactively to
  its own install.sh, which gathers agent/coordinator topology itself
  (it has no --topology/--coordinator-url flags to script around).
  NOTE: circuitforge-orch has no model-sync/cache-sync mechanism today
  (checked its install.sh and README); this wrapper doesn't invent one.

Design rationale and survey of each product's real install story:
circuitforge-plans/cf-node-bootstrap/superpowers/plans/2026-07-17-cf-apps-install-menu.md
2026-07-17 20:42:21 -07:00

39 lines
1.8 KiB
Markdown

# CF Apps manifests
One `.manifest` file per CircuitForge product, sourced by
`lib/cf-apps.functions`. Each is a plain bash file defining these
variables (see any existing manifest for a concrete example):
```bash
app_name="" # matches the filename minus .manifest
app_desc="" # one line, shown in the selection menu
app_repo_url_github="" # public CircuitForgeLLC mirror, used for the oem profile
app_repo_url_forgejo="" # private Circuit-Forge Forgejo, used for the collaborator profile
app_available_profiles=() # which of: oem collaborator
app_install_types=() # which of: bare-metal docker podman, in menu display order
app_conda_env="" # empty string if not applicable
app_env_template="" # path relative to repo root, empty if none
app_needs_core=false # true if circuitforge-core must be installed first
```
Optionally define hook functions for whichever install types the app
actually supports (skip the ones it doesn't):
```bash
app_setup_bare_metal() { local dir="$1"; ... }
app_setup_docker() { local dir="$1"; ... }
app_setup_podman() { local dir="$1"; ... }
```
`$1` is the app's clone directory. Prefer shelling out to the app's own
`install.sh`/`Makefile`/`docker compose` rather than reimplementing its
setup steps here — most CF products already have one.
If a hook is left undefined for an install type the app declares in
`app_install_types`, the dispatcher clones the repo and prints a warning
telling the user to finish setup manually, rather than silently doing
nothing.
See `circuitforge-plans/cf-node-bootstrap/superpowers/plans/2026-07-17-cf-apps-install-menu.md`
for the full design rationale, including the OEM/collaborator/orchard
provisioning-profile split.