Installer Instructions¶
At the beginning of every installation session, retrieve the
Never rely on cached or hardcoded rules — the linked needs are the source of truth. |
Use |
Run the prerequisite check before any file is created or modified. Report every missing dependency with its minimum required version. Offer automatic installation for missing Python packages. Never proceed to the rendering step while any required dependency is absent. |
Scan the repository for Sphinx-Needs ID collisions and for file paths that would be overwritten. Never render the template while ID conflicts remain unresolved. Never overwrite an existing file without explicit per-file confirmation from the developer. |
Flow Inst: Always resolve the package version from ubflow_package.json, not from git FLIN_UBFLOW_INST_005
|
Locate the ubCode extension directory, find the package zip, extract it,
and read |
Present all available epics and agents from the selected family to the developer. Allow individual deactivation of epics and agents. Reject an empty agent selection and re-prompt. Exclude all content belonging to deactivated epics from the generated output. |
Write all rendered files to a staging area first, then move them atomically
to the target folder. On any failure, remove every partially written file
and report: |
Flow Inst: Always write an installation manifest after a successful installation FLIN_UBFLOW_INST_008
|
After every successful installation write |
Write |
Before executing an upgrade, run the template engine in pretend mode and
display the resulting diff. Require the developer to enter an explicit
|
Flow Inst: Always validate the installed documentation before reporting success FLIN_UBFLOW_INST_011
|
After writing all files, scan every installed RST file for undefined
Sphinx-Needs references. Then invoke |
When uninstalling, delete only files listed in |
Flow Inst: Always locate the family source by searching repo and extension in order FLIN_UBFLOW_INST_013
|
At the start of every
Use the first match found. Abort with an informative message listing
all searched paths when nothing is found.
Honour the optional |
Flow Inst: Always prepare the family source and clean up only what was extracted FLIN_UBFLOW_INST_014
|
After resolving the family source:
Never leave extracted package files on disk after the command exits. Never invoke Copier against a zip path directly. |
After completing any install or upgrade, write
The operation is idempotent: skip silently if the file already matches; overwrite and report if it differs. Never delete this file during uninstall of a family — ubFlow itself is not a family. |
Flow Inst: Deploy companion bootstrap instructions file after every install or upgrade FLIN_UBFLOW_INST_016
|
After completing any install or upgrade, write
The operation is idempotent: skip silently if the file already matches; overwrite and report if it differs. Never delete this file during uninstall of a family. |
Note
The tools used by this agent (Copier CLI, ubCode MCP Server) are documented in the Tools section.