Guide
Migrate or upgrade safely
Upgrade Superbee or move from AgentState while preserving the intended workspace and verifying each compatibility step.
Outcome
Upgrade the installed Superbee CLI and reconnect its host integrations while keeping the existing workspace intact. Legacy AgentState installations can move their private operational state into Superbee without relocating bundle content.
This guide is verified against the current stable release evidence, the tagged migration implementations and tests linked below, and a disposable governed OKF v0.1 journey in this documentation repository.
Choose the path that matches your starting point
| Starting point | Supported path |
|---|---|
| A current Superbee installation | Upgrade the global package, verify its identity, and rerun setup for the host. |
An AgentState or aslite installation | Install Superbee, follow any state-migration action reported by setup, then reconnect the host. |
An existing .superbee/ or .agentstate-lite/ workspace | Keep the workspace in place and let normal project discovery find it. |
| An OKF v0.1 bundle | Continue using it. Run status before considering any format change. |
Before changing the installation
Commit or back up any workspace that contains uncommitted work. Then record the current executable and resolved workspace:
superbee version
superbee home
superbee statusIf superbee home resolves an unexpected workspace, stop and correct the project binding or current
directory first. An upgrade should never be used to switch a project's active bundle.
Upgrade Superbee
The current release record is the authority for Node.js and platform support. Confirm that it lists your environment before installing the package.
Install the current stable package:
npm install -g superbeeConfirm the installed package and source identity:
superbee versionThe version and artifact channel should agree with the current release record.
Now inspect the host integration you use:
superbee setup --host <codex|claude-code|claude-desktop|opencode> --scope userSetup returns at most one action. Review that command, approve any configuration change, run it
unchanged, and restart the named host when instructed. Repeat the same setup command until it
reports ready: true and complete: true.
Move from AgentState or aslite
Install Superbee first, then run:
superbee setupWhen setup reports this action, review and run it:
superbee setup migrate-stateThe command copies validated private catalog entries, remote credentials, and immutable View approvals into Superbee's current private-state directory. Existing bundles stay where they are. Legacy private-state bytes remain available for recovery.
Continue with host-specific setup and restart the host when requested. Once the Superbee setup is complete and a fresh session can reach the expected workspace, the old global package can be removed:
npm uninstall -g @holaxis/asliteKeep existing workspaces in place
Superbee discovers both .superbee/ and existing .agentstate-lite/ workspace directories.
Supported .agentstate.json project bindings also remain readable. Use the resolved workspace:
superbee home
superbee statusAvoid running superbee init in a project that already resolves a workspace. Initialization creates
a new workspace and does not upgrade an existing one.
Work with an OKF v0.1 bundle
OKF v0.1 bundles remain supported. When a document's governing Kind declares the v0.1 workflow
field status, Superbee accepts the logical name progress_status and maps it to that declared
storage field:
superbee list --type Task --field progress_status=todo
superbee doc update tasks/<id> --progress_status doneThis compatibility mapping does not apply to ungoverned documents or Kinds that do not declare the
workflow field. Run superbee kinds to inspect the governing conventions before relying on it.
Run superbee status before changing the bundle edition. An okf_upgrade section identifies
registered Kinds that declare the v0.1 physical field status. It does not detect raw status
fields on ungoverned documents, saved queries, or View code. Audit those surfaces separately. The
current CLI keeps the v0.1 bundle usable and does not perform the multi-document conversion.
Keep the existing okf_version while that finding is present. Editing index.md alone would leave
the bundle internally inconsistent.
Check legacy Views
superbee status reports legacy_naming when a bundle still uses the retired Page type or
bridge capability field. A Page document no longer registers as a View. A View with only
bridge still registers with access: none, so it may launch without the bundle capability the
author expected. When both fields exist, current access wins and the stale bridge field is
ignored.
The remedy printed by the current stable package names a repository script that the npm package does not contain. Treat this as a source-only migration. Preserve and back up the bundle, then use a reviewed checkout pinned to the source tag named in the current release record:
git clone --branch <current-stable-source-tag> --depth 1 \
https://github.com/Holaxis-ai/superbee.git /tmp/superbee-migration
cd /tmp/superbee-migration
npm ci
npm run build
node scripts/migrate-legacy-view-names.mjs --dir <bundle-root> --dry-runReview the dry-run receipt and the affected registrations. Run the same script without --dry-run
only after the proposed type, capability, convention, and reference changes are understood. Then
run superbee status and launch each affected View. Avoid independent hand edits to executable View
registrations because the type, entry, and access fields form one trust decision.
Verify the result
Run all four checks from the project that owns the workspace:
superbee version
superbee home
superbee status
superbee setup --host <codex|claude-code|claude-desktop|opencode> --scope userThe installation is ready when:
versionreports the intended stable package;homeresolves the expected workspace;statusshows no new malformed documents or migration findings; andhost setup reports
ready: trueandcomplete: trueafter the required restart.
Open one known document as the final human check:
superbee doc open <document-id>If verification fails
An unexpected workspace usually means the current directory or project binding points elsewhere. Inspect
superbee homebefore changing files.A repeated
migrate-stateoffer means legacy private state still needs inspection. Keep both state directories and use the recovery guidance returned by setup.An
okf_upgradefinding leaves the v0.1 bundle supported. Continue using the logicalprogress_statusinterface for workflows governed by a compatible Kind until a reviewed bundle migration is available.A
legacy_namingfinding affects View registration. Ordinary documents remain readable while the View records are repaired.
Evidence
Private-state migration implementation
Private-state recovery and migration tests
Logical progress-field implementation
OKF upgrade status tests
Legacy View compatibility rules
Source-only legacy View migration
Stable package contents and platform metadata
Journey check
Test this page with one current Superbee installation and one disposable, Kind-governed OKF v0.1
workspace. The reader should preserve the same bundle path, use logical progress_status
successfully, and finish with a verified host setup. Test legacy private-state migration only in an
isolated home directory that contains a supported legacy fixture.