Skip to content

docs(cli): sync interactive menu options and introduce CLI history (#432) - #433

Merged
rosspeili merged 2 commits into
ARPAHLS:mainfrom
rin-katsuragi:docs/issue-432-cli-menu-and-history
Oct 14, 2026
Merged

rosspeili merged 2 commits into
ARPAHLS:mainfrom
rin-katsuragi:docs/issue-432-cli-menu-and-history

Conversation

@rin-katsuragi

Copy link
Copy Markdown
Contributor

Description

Synchronizes docs/usage/cli.md with the current interactive splash menu options and grouped help topics, addresses underlying indexing drift in skillware/cli.py, and introduces the CLI provenance history table.

  • Synchronized the Available commands table to include options 9 (evm) and 10 (addressbook), updating option 6 (help) to reference both new command groups.
  • Added anchor hyperlinks across command groups and commands in docs/usage/cli.md and added skillware addressbook to docs/usage/README.md.
  • Realigned HELP_GROUPS and _HELP_MENU in skillware/cli.py to 14 distinct topics, wiring evm and addressbook into the help submenu and correcting option range notices from 1-8 to 1-10.
  • Appended the 25-commit CLI provenance history table spanning v0.3.5 through v0.4.7 with verified commit hashes, versions, authors, and dates (correcting dd90896 date to 31 May 2026).
  • Added regression tests in tests/test_cli.py covering help topic mapping integrity and CLI docs synchronization.

Type of Change

  • New Skill — new registry bundle under skills/
  • Skill Upgrade — changes to an existing skill under skills/
  • Bug Fix — incorrect runtime or framework behavior
  • Documentation — docs, README, CONTRIBUTING only
  • Framework Feature — skillware/core/ loader, env, adapters
  • CLI — skillware/cli.py, docs/usage/cli.md
  • Examples — examples/*.py, agent loops, examples/README.md
  • Packaging — PyPI wheel, pyproject.toml, MANIFEST.in
  • RFC / meta — templates, labels, CI, or large design doc

Checklist (all PRs)

  • Linked GitHub issue (Fixes #432)
  • Scope matches the issue — no unrelated refactors
  • Contribution complies with Legal notice and code ownership (original work, MIT license grant, no malicious logic)
  • python -m black --check ., flake8, and ruff check . pass locally (or CI-equivalent subset)
  • pytest skills/ and pytest tests/ pass locally when relevant
  • CHANGELOG.md updated under [Unreleased] when user-visible behavior changes
  • examples/README.md updated if this PR adds, renames, or removes a runnable script
  • Ran pytest tests/test_registry_docs.py when skills, examples index, or agent-loops matrix changed
  • Ran pytest tests/test_skill_docs.py when catalog Usage Examples or provider snippets changed

Related Issues

Fixes #432

…ble (ARPAHLS#432)

Synchronize interactive splash menu commands in docs/usage/cli.md with current options (adding 9 / evm and 10 / addressbook). Add anchor links to command groups and commands for seamless cross-doc referencing. Update _HELP_MENU and HELP_GROUPS in skillware/cli.py to include EVM and addressbook topics, correcting option indices and range notices (1-10). Append verified CLI provenance history table documenting 25 key commits from v0.3.5 through v0.4.7 with accurate commit hashes, dates, and authors. Update docs/usage/README.md and CHANGELOG.md. Add regression tests in tests/test_cli.py.

@rosspeili rosspeili left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @rin-katsuragi! The code fix in skillware/cli.py swapping EVM/Addressbook to align _HELP_MENU and the updated menu tables in docs/usage/cli.md look great and good thinking ahead.

Before we can merge, we need to polish the CLI history table:

  1. Table Schema Consistency: Align the columns with the established standard used across all docs/skills/*/*.md history tables:
    | Commit | Description | Date | Version | Contributors |
  2. Contributor Attribution & Links: Several commits were authored by community contributors but are currently attributed to Ross. Also, contributors must be linked to their GitHub profiles ([@handle](https://github.com/handle)):
  3. Commit Date & Test Assertion: Commit dd90896 is 14 Jun 2026 (not 31 May). Please update both the doc row and the test assertion in tests/test_cli.py (assert "14 Jun 2026" in cli_md).

@rin-katsuragi

Copy link
Copy Markdown
Contributor Author

Thanks for the review and guidance @rosspeili!

I am so sorry for messing that up. I updated with a new commit. Hope this is better now.

@rosspeili

Copy link
Copy Markdown
Contributor

Nw at all @rin-katsuragi, this LGTM. Merging as is. Well done <3

@rosspeili
rosspeili merged commit cdd258f into ARPAHLS:main Oct 14, 2026
7 checks passed
@rin-katsuragi rin-katsuragi changed the title docs(cli): sync interactive menu options and introduce CLI history ta… docs(cli): sync interactive menu options and introduce CLI history (#432) Oct 14, 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]: Sync cli.md with interactive menu options and introduce CLI history table

2 participants