Skip to content

docs: install from the v0.1.0 release; plugin 0.2.0 checks the CLI's version - #86

Merged
Teg79 merged 1 commit into
mainfrom
docs/release-v0.1.0
Nov 17, 2026
Merged

Teg79 merged 1 commit into
mainfrom
docs/release-v0.1.0

Conversation

@Teg79

@Teg79 Teg79 commented Nov 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • README.md:
    • status: preview release (v0.1.0), linking the release and the known limitations (no backups yet, Proxmox only, one operator);
    • install from the release;
    • bug reports include urbex version;
    • Upgrading in the docs index.
  • docs/getting-started/with-the-cli.md:
    • Get Urbex downloads urbex-op from the release (curl), which pulls ghcr.io/urbforge/urbex-op:0.1.0;
    • Native tools downloads the archive for the system, checks it against checksums.txt (shasum -a 256 -c on macOS), and names the tool versions of the release's mise.toml;
    • building from source points to urbex-cli's Build & test.
  • docs/getting-started.md: preview note; the prerequisites table without Go or a checkout.
  • docs/getting-started/with-claude-code.md, with-an-ai-agent.md: the plugin downloads urbex-op; the prompt clones only urbex and downloads urbex-op; the plugin and CLI versions.
  • docs/cookbook.md (Run urbex from a container): from the release; a checkout's urbex-op build as the alternative.
  • docs/upgrading.md (new): moving to a new release with urbex-op (download over it, the next command pulls the image, going back), from a checkout, native, and the plugin, with Plugin and CLI versions:
    • the plugin has its own version and works with any CLI of the same major;
    • while 0.x it also states a minimum: plugin 0.2.0 needs urbex 0.1.0 or later.
  • docs/reference/cli.md: urbex version (text, --version, JSON), and the version line at the top of urbex doctor and in its JSON (feat(cli): urbex version urbex-cli#105).
  • docs/known-limitations.md: what preview means, in short. docs/status.md: a Distribution row.
  • Plugin, 0.1.4 → 0.2.0:
    • skills/setup/SKILL.md: step 3 downloads urbex-op from the newest release (pre-releases included: while 0.x, releases/latest finds none), runs init (which pulls the image) and urbex version, and keeps an existing checkout's urbex-op.
    • skills/setup/check-prerequisites.sh: reads the image from urbex-op version (a pre-release script falls back to urbex-operator); says whether it's pulled or needs a build; checks urbex-cli's releases are reachable, instead of access to a private repo.
    • skills/cli/SKILL.md: Versions. Once per session urbex version: older than 0.1.0 (or no version command) → upgrade; another major → update the plugin; dev is fine. Upgrading points to the docs.

Merge after v0.1.0 is published: the links to releases/tag/v0.1.0 and releases/download/v0.1.0/... answer only then. urbex is tagged v0.1.0 together with urbex-cli (Teg).

Depends on urbforge/urbex-cli#105, urbforge/urbex-cli#106 and urbforge/urbex-cli#107.

Why

With binaries and the urbex-op image published, the docs and the plugin should start from the release, not from a clone (v0.1.0, urbforge/redemptor#53).

Tests I ran

  • Relative links and anchors of every changed page: all resolve.
  • tests/plugin-scripts.sh: passes. check-prerequisites.sh on this machine: the new lines (podman, releases reachable).
  • The commands in Get Urbex and the plugin's step 3 were run against the local images of build(release): publish the urbex-op image on ghcr.io and use it by default urbex-cli#107 (a release-target image from a local, unpushed v0.1.0-rc.0, and urbex-op with its version set). Not against the published release: it doesn't exist yet.
  • The curl ... releases?per_page=1 lookup: the API answers (an empty list today: no release yet); the newest release, pre-releases included, is the first item once there is one - to check after the tag.
  • Not run: the docs from the published v0.1.0 (after the tag), the plugin's setup end to end from the release.

Checklist before review

  • Linked issue, Conventional Commit title
  • No secrets, tokens or private addresses (example.com, no LAN address)
  • Relative links and anchors resolve
  • Plugin version bumped (0.2.0), skills updated
  • Checked against the published v0.1.0 (after the tag)

Fixes #85

🤖 Generated with Claude Code

https://claude.ai/code/session_0182yxsfwRowwnxCfgrQwjnA

@Teg79
Teg79 marked this pull request as ready for review November 16, 2026 21:01
@Teg79
Teg79 merged commit 74b8dcd into main Nov 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: install from the release, and the plugin's setup without a clone

2 participants