Skip to content

docs: README documents unreleased subcommands (config/doctor/snapshot/record) absent from v0.20.1 release — not Windows-specific #214

Description

@eabase

Summary

The latest published release v0.20.1 does not include the config, doctor, snapshot, or record subcommands, but the README on main documents all of them as if they are current, shipped features. A user on Windows 11 Pro ran all-smi.exe config (v0.20.1) and got error: unrecognized subcommand 'config'.

This is not Windows-specific. These subcommands are absent on every platform in v0.20.1 because they were merged to main after the v0.20.1 tag and have not been released yet. The user followed the README, downloaded the latest release binary, and reasonably (but mistakenly) concluded the problem was Windows.

Background

  • The config subcommand was introduced in feat: TOML config file support #202 (12bf2b2), which is one of 27 commits on main made after the v0.20.1 tag.
  • Verified against the tag: v0.20.1 does not contain src/cli_config.rs, and its Commands enum only has Api, Local, and View. So config (and friends) cannot exist in any v0.20.1 binary, regardless of OS or build flags.
  • The subcommands all live behind the default cli feature (required-features = ["cli"]), so feature-gating is not the cause — they simply post-date the release.
  • Unreleased subcommands that the README body presents as available now:
  • The README Changelog already lists these under "v0.21.0 (upcoming)" (~L1305), which directly contradicts the body sections that describe them as shipped. The documentation is therefore internally inconsistent.
  • The install path reproduces the report: "Option 4: Download Pre-built Binary" sends users to the releases page, which currently serves v0.20.1. release.yml does build a Windows artifact (x86_64-pc-windows-msvcall-smi.exe), so the binary is genuine — it just predates these features.

Proposed Solution

Two complementary fixes; either one resolves the report, and doing both is ideal:

  1. (Preferred) Cut the v0.21.0 release. The changelog already stages v0.21.0 with config/doctor/snapshot/record. Releasing it makes the README match a published binary on all platforms, Windows included.
  2. Until v0.21.0 ships, make availability explicit in the docs. Add a short "Availability: v0.21.0+" note (or a "these docs track main; see the Changelog for what is shipped" banner) to the Command Overview, Configuration, and Diagnostics sections so users on v0.20.1 are not misled.

Optional follow-up:

  1. Confirm the v0.20.1-era subcommands (view, api, local) actually run on Windows 11, to fully close out the user's broader "none of the subcommands work" statement (they most likely only tried the newly documented ones).

Implementation Notes

  • No source change is needed for the subcommands themselves — they already exist and compile for Windows under the default feature set.
  • If gating docs (option 2), the files to touch are in README.md: Command Overview (~L96–122), Configuration (~L159–195), and Diagnostics (~L321–350). Keep wording consistent with the Changelog's "v0.21.0".
  • Minor related doc drift noticed during investigation: several README install links point to github.com/inureyes/all-smi/... while the canonical repository is lablup/all-smi. Worth reconciling in the same documentation pass (secondary, not blocking).

Acceptance Criteria

  • Resolution path chosen: release v0.21.0, version-gate the docs, or both.
  • If releasing: v0.21.0 is published with a Windows artifact, and all-smi.exe config --help, doctor, snapshot, and record all work on Windows 11.
  • If gating docs: README Command Overview / Configuration / Diagnostics sections clearly state the minimum version for config, doctor, snapshot, and record, consistent with the Changelog's "v0.21.0".
  • README internal inconsistency resolved: the body no longer presents unreleased subcommands as shipped while the Changelog calls them "upcoming".
  • (Optional) view / api / local confirmed working on Windows 11 under v0.20.1, addressing the "none work" claim.
  • (Optional) README repository links (inureyeslablup) reconciled.

Original Suggestion

Title: [bug] Subcommands (like config) doesn't work on Windows

None of the sub-commands in the README works on Windows-11 Pro.

# all-smi.exe -V
all-smi 0.20.1

# all-smi.exe config

error: unrecognized subcommand 'config'

Usage: all-smi.exe [COMMAND]

For more information, try '--help'.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:mediumMedium priority issuestatus:doneCompletedtype:docsImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions