From 31b9e8aa803c9ea4763067c5f9d681424ee4acbb Mon Sep 17 00:00:00 2001 From: redbasecap Date: Wed, 26 Aug 2026 18:28:05 +0200 Subject: [PATCH 1/2] docs(readme): improve install section structure and clarity Restructure the Install section with prerequisites, separate release and development paths, fenced code blocks, and a restart/verification note. Preserve all required user-facing behavior asserted by tests/docs-asset.test.ts. --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 42191e7..f8caa27 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,39 @@ It uses no proxy. It does not replace the selected model, create synthetic model ## Install +### Prerequisites + +- [opencode](https://opencode.ai) is installed and on your `PATH`. +- For the development path only: Node.js 22+ and `pnpm` (the repo pins `pnpm@11.4.0` via Corepack). + +### Release install (recommended) + 1. Install the latest release with `curl -fsSL https://raw.githubusercontent.com/norandom/OpenUltraCode/main/install.sh | sh`. -2. If you already have a checkout and want the development path, run `./install-dev.sh` from the repo root. -3. The release installer pulls the latest GitHub release asset, copies the skill, slash commands, and agents into `~/.config/opencode/`, asks which fusion model IDs to set, and registers the plugin path in `~/.config/opencode/opencode.json`. -4. Quit and restart opencode so the global plugin, commands, skills, and agents are loaded. -The restart matters because opencode loads plugins, commands, skills, agents, and config at startup. If `/ultracode` does not appear, confirm you restarted opencode after running `install.sh` or `install-dev.sh`. + ```sh + curl -fsSL https://raw.githubusercontent.com/norandom/OpenUltraCode/main/install.sh | sh + ``` + +The installer pulls the latest GitHub release asset, copies the skill, slash commands, and agents into `~/.config/opencode/`, prompts you to choose the fusion model IDs, and registers the plugin path in `~/.config/opencode/opencode.json`. + +### Development install + +From a checkout of this repo: + +```sh +./install-dev.sh +``` + +This also configures the repository pre-commit hook to run Dagger-backed ESLint through `pnpm run lint`. + +### Restart opencode + +Quit and restart opencode so the global plugin, commands, skills, and agents are loaded. opencode reads plugins, commands, skills, agents, and config only at startup, so this step is required. If `/ultracode` does not appear after restarting, re-run `install.sh` or `install-dev.sh` and restart again. -Release installs do not run Dagger or `pnpm run check` on the user's machine. The GitHub Actions release workflow runs build, ESLint, tests, and asset validation, then publishes `open-ultracode-release.tar.gz` as the GitHub release asset consumed by `install.sh`. +### Install notes -Development installs use pnpm with a 3-day release-age cooldown (`minimumReleaseAge: 4320` in `pnpm-workspace.yaml`). That keeps brand-new package releases out of the install path. `pnpm-workspace.yaml` allows the `esbuild` install script because the TypeScript test runner needs it. `install-dev.sh` also configures the repository pre-commit hook to run Dagger-backed ESLint through `pnpm run lint`. +- **Release installs** do not run Dagger or `pnpm run check` on your machine. The GitHub Actions release workflow runs build, ESLint, tests, and asset validation, then publishes `open-ultracode-release.tar.gz`, which `install.sh` consumes. +- **Development installs** use pnpm with a 3-day release-age cooldown (`minimumReleaseAge: 4320` in `pnpm-workspace.yaml`) to keep brand-new package releases out of the install path. `pnpm-workspace.yaml` allows the `esbuild` install script because the TypeScript test runner needs it. ## What you get From c48fed4420737678f0bf98bc58bb3d1338264e25 Mon Sep 17 00:00:00 2001 From: redbasecap Date: Wed, 26 Aug 2026 18:45:09 +0200 Subject: [PATCH 2/2] docs(readme): dedupe curl command and soften restart troubleshooting - Drop the redundant inline curl command and lone numbered step; keep the code block - Name install-dev.sh explicitly instead of a dangling "This also" - Restore "confirm you restarted" as the first troubleshooting step before re-running the installer Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01YMFa3tAeGzainohPXsLwph --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f8caa27..62fd55c 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ It uses no proxy. It does not replace the selected model, create synthetic model ### Release install (recommended) -1. Install the latest release with `curl -fsSL https://raw.githubusercontent.com/norandom/OpenUltraCode/main/install.sh | sh`. +Install the latest release: - ```sh - curl -fsSL https://raw.githubusercontent.com/norandom/OpenUltraCode/main/install.sh | sh - ``` +```sh +curl -fsSL https://raw.githubusercontent.com/norandom/OpenUltraCode/main/install.sh | sh +``` The installer pulls the latest GitHub release asset, copies the skill, slash commands, and agents into `~/.config/opencode/`, prompts you to choose the fusion model IDs, and registers the plugin path in `~/.config/opencode/opencode.json`. @@ -29,11 +29,11 @@ From a checkout of this repo: ./install-dev.sh ``` -This also configures the repository pre-commit hook to run Dagger-backed ESLint through `pnpm run lint`. +`install-dev.sh` also configures the repository pre-commit hook to run Dagger-backed ESLint through `pnpm run lint`. ### Restart opencode -Quit and restart opencode so the global plugin, commands, skills, and agents are loaded. opencode reads plugins, commands, skills, agents, and config only at startup, so this step is required. If `/ultracode` does not appear after restarting, re-run `install.sh` or `install-dev.sh` and restart again. +Quit and restart opencode so the global plugin, commands, skills, and agents are loaded. opencode reads plugins, commands, skills, agents, and config only at startup, so this step is required. If `/ultracode` does not appear, first confirm you restarted opencode after running `install.sh` or `install-dev.sh`; if it still does not appear, re-run the installer and restart again. ### Install notes