Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 44 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,54 @@ Requires **Python 3.10+**. Licensed under [Apache-2.0](LICENSE).

**InferRSI is a Developer Preview (pre-release), with no API stability promise.**
The [daily release bot](docs/releases.md) publishes a version when the default
branch changes. This preview is not on PyPI. Download the wheel and `SHA256SUMS`
from the selected [Release](https://github.com/InferMatrixLab/InferRSI/releases),
verify its checksum, then install the downloaded wheel:
branch changes.

### Use InferRSI in Codex

Install the plugin in two steps. Use a local Codex client with ZIP upload support,
Python 3.10+ and Git.

1. **Download the package from GitHub.** Open
[Releases](https://github.com/InferMatrixLab/InferRSI/releases) and download
`inferrsi-codex-plugin-vX.Y.Z.zip` from the selected version's assets.
2. **Install it in Codex.** Open **Plugins → Add → Upload plugin archive** and
select the downloaded ZIP to import it. On the InferRSI detail page, click
**Install plugin** to install it. Once installed, enable InferRSI and start a
new conversation in your target repository.

[Installation video (English)](docs/assets/inferrsi-codex-install-en.mp4)

The runtime and knowledge are bundled; core operations need no separate pip
install or InferRSI source checkout. The [plugin guide](docs/codex-plugin.md#install-from-the-release-zip)
covers checksum verification and client compatibility. The video highlights the
click order with English UI illustrations based on the supplied Codex screenshots;
it does not record a completed installation.

Try a first task:

> Use InferRSI to research this engine's memory bottleneck. Find relevant
> knowledge and explain what is needed for a controlled comparison.

Or inspect existing evidence:

> Use InferRSI to inspect the existing run I provide and explain its verdict,
> missing evidence and next action.

Setup checks readiness without starting benchmarks. Experiments run locally on
the prepared target machine using your accepted gates and budget. See the
[plugin guide](docs/codex-plugin.md#install-from-the-release-zip) for installation,
updates and troubleshooting.

### Use the CLI

This preview is not on PyPI. Download the wheel and `SHA256SUMS` from the selected
[Release](https://github.com/InferMatrixLab/InferRSI/releases), verify its checksum,
then install the downloaded wheel:

```bash
python -m pip install "<download-directory>/inferrsi-<version>-py3-none-any.whl"
```

For Codex, use the [standalone plugin ZIP](docs/codex-plugin.md#install-from-the-release-zip).
For CLI development from this checkout:

```bash
Expand Down Expand Up @@ -168,7 +207,7 @@ campaigns out of the common AB/BA scheduler, process cleanup and evaluator.
![InferRSI system architecture: inputs, experiment loop and evidence](docs/assets/system-architecture-en.svg)

[English SVG](docs/assets/system-architecture-en.svg) ·
[中文原图](docs/assets/system-architecture-zh-CN.svg)
[Chinese original](docs/assets/system-architecture-zh-CN.svg)

The supplied overview and its English translation summarize the intended workflow.
Evidence feeds the next experiment through explicit review and user-selected
Expand Down
Binary file added docs/assets/inferrsi-codex-install-en.mp4
Binary file not shown.
33 changes: 20 additions & 13 deletions docs/codex-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,18 @@ The downloaded archive bundles the same-version InferRSI runtime and knowledge;
installation requires no source checkout, package build or separate pip install.
There is no marketplace catalog, registration step or distribution branch.

In a Codex client with **Plugin Creator** available, provide the downloaded ZIP
and ask: "Import this InferRSI plugin ZIP as a private plugin." For an existing
InferRSI plugin, ask to update that plugin from the ZIP instead of creating a
duplicate. Use the returned plugin link to enable it, then start a new
conversation. The import uploads the archive to the account/workspace; it still
requires a network connection. Here, offline package means the runtime and
resources are included, not that the Codex client can operate air-gapped.
In a Codex client with ZIP upload support, open **Plugins → Add → Upload plugin
archive**. Select the downloaded `inferrsi-codex-plugin-vX.Y.Z.zip` to import it.
On the InferRSI detail page, click **Install plugin** and follow the installation
prompts. After installation, enable InferRSI, open your target repository and
start a new conversation.

[Watch or download the installation guide (English narration and subtitles)](assets/inferrsi-codex-install-en.mp4?raw=1).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

F1 — medium, must-fix — broken link in the shipped plugin README

  • Where: docs/codex-plugin.md:38
  • Problem: the new link [Watch or download the installation guide ...](assets/inferrsi-codex-install-en.mp4?raw=1) is repository-relative, but docs/codex-plugin.md is copied verbatim into every release ZIP as inferrsi/README.md (tools/build_codex_plugin.py:75), and the archive never contains docs/assets. The guide itself promises README.md inside the archive (docs/codex-plugin.md:25), and tools/check_release.py:124 restricts plugin entries to plugin.json, skills, runtime, LICENSE, README.md, so assets/ cannot be shipped without changing the release contract. I built the plugin locally and confirmed the result: asset files in archive: [], relative link: assets/inferrsi-codex-install-en.mp4?raw=1 -> exists in archive: False.
  • Conditions: any reader of the installed/extracted plugin README (the copy inside inferrsi-codex-install-en/inferrsi-codex-plugin-vX.Y.Z.zip) clicks the video link.
  • Impact: the only video reference in the distributed plugin guide resolves to a non-existent path, so the installation tutorial is unreachable from the shipped artifact; only the GitHub-rendered docs/ copy works.
  • Fix: use an absolute URL for this link (many links in this guide are already absolute), e.g. https://github.com/InferMatrixLab/InferRSI/blob/main/docs/assets/inferrsi-codex-install-en.mp4?raw=1 (or an equivalent raw/release URL), or have tools/build_codex_plugin.py rewrite/map the path while honouring check_plugin's allowed entries. A regression check that bundled-README relative links resolve would prevent this from recurring.

The video uses English UI illustrations based on the supplied screenshots to show
the menu click order; it does not record a completed upload or installation.
Exact labels and availability depend
on the client and workspace permissions. Here, offline package describes the
included runtime and resources; it does not guarantee offline client operation.

Clients without archive import cannot install this package directly. The current
Codex CLI's `plugin add` accepts marketplace selectors, not ZIP paths; do not pass
Expand Down Expand Up @@ -105,15 +110,17 @@ source owners. No new core dependencies or CI lanes are introduced.

## Updates, disable and uninstall

Download and verify the new Release ZIP, then ask Plugin Creator to update the
existing InferRSI plugin from that archive. Check the selected bundle with
Download and verify the new Release ZIP, then use the client's supported update
or replacement flow for the existing InferRSI plugin. Check the selected bundle with
`--plugin-info` in a new conversation. Do not overwrite an installed cache or
carry forward an old runtime by hand.

Plugin Creator updates overlay existing files. Ask it to compare the old and new
runtime manifests and explicitly delete removed runtime/resources while retaining
the same plugin identity and audience; omitting a file from the ZIP alone does
not remove its installed copy.
For existing installations managed through Plugin Creator, its file updates
overlay existing files. Compare the old and new runtime manifests and explicitly
remove obsolete runtime/resources while retaining the same plugin identity and
audience; omitting a file from that update archive alone does not remove its
installed copy. This overlay behavior does not establish how the native ZIP
upload UI handles replacement; verify the selected version in the target client.

Disable InferRSI in the desktop plugin UI when you want to retain its installation
but stop loading it. To uninstall, remove the selected InferRSI plugin in the
Expand Down
Loading