docs: document summary output and update workflow

This commit is contained in:
Julian lechner committed 2026-09-16 16:52:52 +02:00
1 parent e02b6cfed2
commit 9d23c4455e
2 files changed
+43 -16

No files matched your search

+37 -14
View File
@@ -25,9 +25,11 @@ into platform-specific packages that can be inspected before they are installed.
or deleting them. or deleting them.
- Dry-run support (no writes, no backups, no plugin changes) and timestamped, per-run backup directories. - Dry-run support (no writes, no backups, no plugin changes) and timestamped, per-run backup directories.
- Shared safety, notification, validation, and status-line hooks. - Shared safety, notification, validation, and status-line hooks.
- User-level plugin installation for Ponytail, i-have-adhd, Superpowers, Context7, Caveman, Humanizer, Impeccable, - Separate install and update scripts: install refuses to run against an already-installed destination, update refuses
and Anthropic Frontend Design; updates only with to run against one that is not installed yet.
`-UpdatePlugins`/`--update-plugins`. - User-level plugin installation for Ponytail, i-have-adhd, Superpowers, Context7, Caveman, Humanizer, Impeccable, and
Anthropic Frontend Design, with an interactive per-plugin toggle during both install and update; update pre-checks
plugins that are already installed, so unchecking one uninstalls it and checking one installs or updates it.
## Architecture ## Architecture
@@ -40,7 +42,7 @@ shared definitions -> client adapters -> generated packages -> user installation
| `shared/` | Client-independent rules, agents, skills, hooks, status lines, and global instructions. | | `shared/` | Client-independent rules, agents, skills, hooks, status lines, and global instructions. |
| `adapters/` | Codex and Claude Code formats, settings, templates, and the plugin manifest. | | `adapters/` | Codex and Claude Code formats, settings, templates, and the plugin manifest. |
| `generated/` | Reproducible Windows and Linux packages. This directory is ignored by Git. | | `generated/` | Reproducible Windows and Linux packages. This directory is ignored by Git. |
| `scripts/` | Build, installation, diagnosis, and platform validation entry points. | | `scripts/` | Build, installation, update, diagnosis, and platform validation entry points. |
| `docs/` | Focused documentation about the configuration design. | | `docs/` | Focused documentation about the configuration design. |
The build creates: The build creates:
@@ -82,9 +84,10 @@ Every repository change must pass the build before completion. Building only wri
## Installation ## Installation
The installer runs a fresh build and then asks for the target platform and client, unless they are passed as The installer asks for the target platform and client, unless they are passed as parameters, then refuses to continue
parameters. Selecting Linux or Windows chooses the generated package format; installation always targets the current if any selected destination is already installed (`Already installed, use the update script.`). Selecting Linux or
user's home directory. Windows chooses the generated package format; installation always targets the current user's home directory. This
check is skipped for a dry run, so previewing always works regardless of prior install state.
Preview an installation without changing user files, backups, or plugins: Preview an installation without changing user files, backups, or plugins:
@@ -131,11 +134,30 @@ and left in place with a warning instead. A file the installer never tracked is
same name is now part of the package. Backups land in a single timestamped directory per run under same name is now part of the package. Backups land in a single timestamped directory per run under
`backups/<timestamp>/` inside each destination. `backups/<timestamp>/` inside each destination.
Selecting Codex also installs shared skills to `.agents/skills`. A normal installation only installs plugins that are Selecting Codex also installs shared skills to `.agents/skills`. Before plugins are installed, an interactive list lets
missing; add `-UpdatePlugins`/`--update-plugins` to also update and enable plugins that are already installed. you toggle each configured plugin on or off (all checked by default); unchecked plugins are skipped. This step is also
skipped for a dry run.
Run the same installation command whenever the repository configuration should be updated. There is no separate update ## Update
script.
Once a destination is installed, use the update script (not the installer) to refresh its files and plugins. It refuses
to continue if any selected destination is not installed yet (`Not installed, use the install script.`), also skipped
for a dry run.
Powershell: (Windows)
```powershell
.\scripts\update.ps1
```
Bash: (Linux)
```bash
./scripts/update.sh
```
It accepts the same `-DryRun`/`--dry-run`, `-Client`/`--client`, and `-Platform`/`--platform` parameters as the
installer, re-syncs every managed file the same way, and shows the same plugin toggle list — but pre-checks plugins
that are already installed. Checking a plugin that is not installed installs it; checking one that is installed
updates it; unchecking an installed plugin uninstalls it.
## Doctor ## Doctor
@@ -151,7 +173,8 @@ Bash: (Linux)
./scripts/doctor.sh ./scripts/doctor.sh
``` ```
The doctor reports concise `PASS`, `WARN`, and `FAIL` results without reading or printing credentials. Use `-Summary` (PowerShell) or `--summary` (Bash) with build, doctor, install, update, and test scripts for compact output.
Omit the flag for detailed output. Warnings and failure diagnostics remain visible in both modes.
## Configuration ## Configuration
@@ -159,8 +182,8 @@ Codex receives global instructions, rules, skills, agent TOML files, hooks, and
workspace-scoped and use automatic review for eligible escalation requests. Every rule ships as a plain file under workspace-scoped and use automatic review for eligible escalation requests. Every rule ships as a plain file under
`rules/`, and `AGENTS.md` tells Codex to load the matching one by path. `rules/`, and `AGENTS.md` tells Codex to load the matching one by path.
Claude Code receives the equivalent global instructions, agents, hooks, and `settings.json`. Only `general.md` ships as Claude Code receives the equivalent global instructions, agents, hooks, and `settings.json`. General rules are embedded
an always-applied rule file (its content is also embedded directly in `CLAUDE.md`); every technology- or once in `CLAUDE.md` (and in Codex's `AGENTS.md`); every technology- or
situation-specific rule (`adapters/claude/rule-skills.tsv`) is generated as a skill under `skills/rules/` instead, so situation-specific rule (`adapters/claude/rule-skills.tsv`) is generated as a skill under `skills/rules/` instead, so
only its name and description are permanently visible and the full rule text loads only when Claude invokes it. Its only its name and description are permanently visible and the full rule text loads only when Claude invokes it. Its
generated settings use the supported automatic permission mode where available. generated settings use the supported automatic permission mode where available.
+6 -2
View File
@@ -2,9 +2,13 @@
The user-level plugin manifest is `adapters/plugins.tsv`. It maps each logical plugin to the marketplace selector understood by Claude Code and Codex. The user-level plugin manifest is `adapters/plugins.tsv`. It maps each logical plugin to the marketplace selector understood by Claude Code and Codex.
The current baseline includes Ponytail, i-have-adhd, Superpowers, Context7, Caveman, Humanizer, Impeccable, and Anthropic Frontend Design. The install script operates at user scope and is idempotent: a normal run only installs missing plugins (a disabled but already-installed Claude plugin is re-enabled). Pass `-UpdatePlugins`/`--update-plugins` to also update plugins that are already installed, so a configuration update never silently updates third-party plugin code. The current baseline includes Ponytail, i-have-adhd, Superpowers, Context7, Caveman, Humanizer, Impeccable, and Anthropic Frontend Design. Both the install and update scripts operate at user scope and show an interactive list to toggle each configured plugin on or off before applying anything (skipped for a dry run).
Codex receives Caveman through its native plugin adapter. Humanizer and Anthropic Frontend Design are installed through the cross-agent Skills CLI; Impeccable uses its provider-aware Codex installer. All four are therefore available to both clients, although Codex does not expose all four as marketplace plugins. `install.ps1`/`install.sh` starts every plugin checked by default; unchecking one skips it. It refuses to run against an already-installed destination (`Already installed, use the update script.`).
`update.ps1`/`update.sh` starts each plugin checked to match what is already installed (a disabled but installed Claude plugin still counts as installed and is re-enabled), so a plain confirm re-syncs and updates the existing set without silently touching anything else. Checking a plugin that is not installed installs it; unchecking an installed plugin uninstalls it (`claude plugin uninstall`/`codex plugin remove`). It refuses to run against a destination that is not installed yet (`Not installed, use the install script.`).
Codex receives Caveman through its native plugin adapter. Humanizer and Anthropic Frontend Design are installed through the cross-agent Skills CLI; Impeccable uses its provider-aware Codex installer. All four are therefore available to both clients, although Codex does not expose all four as marketplace plugins. Because those three have no install/uninstall state on Codex, they are always ensured on every Codex run and are left out of the toggle list when only Codex is selected (they still appear, toggleable, for Claude or Both).
Plugin installation requires the corresponding client CLI, network access, and any authentication required by the plugin. Context7 may open an OAuth flow. Codex or plugin hooks may require a trust review in `/hooks`. The scripts never install plugins during a build or doctor run and never install them when `--dry-run` or `-DryRun` is used. Plugin installation requires the corresponding client CLI, network access, and any authentication required by the plugin. Context7 may open an OAuth flow. Codex or plugin hooks may require a trust review in `/hooks`. The scripts never install plugins during a build or doctor run and never install them when `--dry-run` or `-DryRun` is used.