docs(CLI): a show view that takes an operand is not a command the rest refuse #2074

Merged
jaylouisw merged 1 commit from docs/1119-0247 into main 2026-11-19 03:46:35 +00:00
Owner

docs/CLI.md said only show interfaces <port> and show power inline <port> take a port name and "the rest take nothing". The parser accepts narrower operands on more views, and the same page documents them later:

  • engine/cli.js:4907 — show ip ospf neighbour <port> filters to one port; engine/cli.js:5011 usage line show ip ospf [process | neighbour [<port>] | interface [<port>]]
  • engine/cli.js:4650 — show ip dhcp binding takes an address or MAC (want filter)
  • engine/cli.js _dns zone view takes a zone name; docs already show show ip dns zone <name>

Reworded the sentence so the refusal rule still holds for the views that take nothing, while naming the operands the console accepts. No new backticked show forms, so the page still reads 59 forms / 118 commands and 74 refusals.

Guards: syntax-check OK (435 files); docs-cli-transcript 4/4; docs-show-commands 7/7 (59 forms, 118 commands, 74 refusals); help-completeness 8/8 (19 mechanisms, 102 advertised commands, 16 shows); help-key-works 10/10; doc-catalog-counts 43/43.

`docs/CLI.md` said only `show interfaces <port>` and `show power inline <port>` take a port name and "the rest take nothing". The parser accepts narrower operands on more views, and the same page documents them later: - `engine/cli.js:4907` — `show ip ospf neighbour <port>` filters to one port; `engine/cli.js:5011` usage line `show ip ospf [process | neighbour [<port>] | interface [<port>]]` - `engine/cli.js:4650` — `show ip dhcp binding` takes an address or MAC (`want` filter) - `engine/cli.js` `_dns` zone view takes a zone name; docs already show `show ip dns zone <name>` Reworded the sentence so the refusal rule still holds for the views that take nothing, while naming the operands the console accepts. No new backticked `show` forms, so the page still reads 59 forms / 118 commands and 74 refusals. Guards: syntax-check OK (435 files); docs-cli-transcript 4/4; docs-show-commands 7/7 (59 forms, 118 commands, 74 refusals); help-completeness 8/8 (19 mechanisms, 102 advertised commands, 16 shows); help-key-works 10/10; doc-catalog-counts 43/43.
docs(CLI): a show view that takes an operand is not a command the rest refuse
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 10s
CI / Server smoke test (pull_request) Successful in 10s
CI / Docker build (pull_request) Successful in 22s
CI / Test (Node 20) (pull_request) Successful in 53s
CI / Test (Node 22) (pull_request) Successful in 57s
CI / Test (Node 18) (pull_request) Successful in 1m0s
CI / Arm auto-merge (pull_request) Successful in 3s
35d675889a
forgejo-actions force-pushed docs/1119-0247 from 35d675889a
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 10s
CI / Server smoke test (pull_request) Successful in 10s
CI / Docker build (pull_request) Successful in 22s
CI / Test (Node 20) (pull_request) Successful in 53s
CI / Test (Node 22) (pull_request) Successful in 57s
CI / Test (Node 18) (pull_request) Successful in 1m0s
CI / Arm auto-merge (pull_request) Successful in 3s
to f58978e5f4 2026-11-19 02:54:18 +00:00
Compare
jaylouisw force-pushed docs/1119-0247 from f58978e5f4 to 7159f06c13
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 9s
CI / Server smoke test (pull_request) Successful in 10s
CI / Docker build (pull_request) Successful in 26s
CI / Test (Node 20) (pull_request) Successful in 58s
CI / Test (Node 18) (pull_request) Successful in 1m5s
CI / Test (Node 22) (pull_request) Successful in 1m2s
CI / Arm auto-merge (pull_request) Successful in 6s
2026-11-19 03:13:07 +00:00
Compare
forgejo-actions force-pushed docs/1119-0247 from 7159f06c13
All checks were successful
CI / Classify the change (pull_request) Successful in 8s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 9s
CI / Server smoke test (pull_request) Successful in 10s
CI / Docker build (pull_request) Successful in 26s
CI / Test (Node 20) (pull_request) Successful in 58s
CI / Test (Node 18) (pull_request) Successful in 1m5s
CI / Test (Node 22) (pull_request) Successful in 1m2s
CI / Arm auto-merge (pull_request) Successful in 6s
to 882f98ec2f 2026-11-19 03:13:24 +00:00
Compare
jaylouisw force-pushed docs/1119-0247 from 882f98ec2f to 460c928192
All checks were successful
CI / Classify the change (pull_request) Successful in 13s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 8s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 54s
CI / Test (Node 22) (pull_request) Successful in 55s
CI / Test (Node 18) (pull_request) Successful in 59s
CI / Arm auto-merge (pull_request) Successful in 3s
2026-11-19 03:44:22 +00:00
Compare
jaylouisw deleted branch docs/1119-0247 2026-11-19 03:46:37 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!2074
No description provided.