Skip to content

docs: refresh CLI guide for 1.0.3 - #567

Open
Caesarsage wants to merge 1 commit into
microcks:masterfrom
Caesarsage:docs/refresh-cli-guide
Open

docs: refresh CLI guide for 1.0.3#567
Caesarsage wants to merge 1 commit into
microcks:masterfrom
Caesarsage:docs/refresh-cli-guide

Conversation

@Caesarsage

Copy link
Copy Markdown
Contributor

Refreshes the CLI automation guide, which described the pre-1.0 CLI. 85.

The page had drifted enough to mislead:

  • it invoked microcks-cli test; the binary has been microcks since 1.0.0
  • brew install microcks-cli installs a legacy formula stranded at 0.5.8 — the tap
    carries two, and microcks/tap/microcks is current. This is the root cause of the
    stale binary name throughout the page.
  • the curl example pinned release 0.5.5 and ran chmod +x on a .tar.gz, so it
    could not work as written; macOS also ships as darwin_all, not per-architecture
  • it covered only test and import

Corrected the binary name, formula and install commands, then added sections in the
existing numbered-step voice for login/context and start/stop, imports, --output,
--dry-run, and exit codes in CI. Also replaced a hardcoded Keycloak secret with a
placeholder.

Verification

hugo builds clean, all 15 internal links resolve, and the misspell CI step passes
locally. The install command in the guide was run end to end and extracts a working
binary.

Companion PR: microcks/microcks-cli#509

Signed-off-by: caesarsage <destinyerhabor6@gmail.com>
@Caesarsage

Copy link
Copy Markdown
Contributor Author

cc: @Harsh4902 @Vaishnav88sk

for review

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.

1 participant