didericis
466f4ee13a
tracker-policy-pr / check-pr (pull_request) Successful in 13s
test / integration-docker (pull_request) Successful in 34s
test / unit (pull_request) Successful in 49s
lint / lint (push) Successful in 57s
test / integration-firecracker (pull_request) Successful in 3m29s
test / coverage (pull_request) Successful in 20s
test / publish-infra (pull_request) Has been skipped
Brings in the two commits main gained: #472 (CLI cleanup — remove `info`, split `list active` into a top-level `active`, simplify `list`) and the terminology glossary. #472 was written against the old flat cli/ layout, so its semantics are reconciled into the reorg'd cli/commands/ structure: * new `active` command lives at cli/commands/active.py, registered in the lazy registry and listed in `help` (not left at the flat path). * `info` removed: deleted cli/commands/info.py, dropped from the registry and `help`. * `list` simplified to list-available-only, using the reorg's os.getcwd()/constants.PROG conventions. * the `list active` -> `active` doc wording applied to the backend docstrings that our split moved into base.py / selection.py. Our reorg wins for the fully-rewritten dispatcher (cli/__init__ shim, backend facade). pyright: 0 errors. Full unit suite green (2243). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
38 lines
1.7 KiB
Python
38 lines
1.7 KiB
Python
"""help: print the top-level command list and usage.
|
|
|
|
Rendered by the dispatcher for the `help` command and for its
|
|
`-h`/`--help`, no-args, and unknown-command fallbacks. The per-command
|
|
summaries live here; keep them in sync with the COMMANDS table in
|
|
`bot_bottle.cli`.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import sys
|
|
|
|
from ..constants import PROG
|
|
|
|
|
|
def cmd_help(argv: list[str] | None = None) -> int:
|
|
"""Write the top-level usage + command list to stderr. Returns 0;
|
|
the dispatcher chooses the process exit code per entry path (0 for an
|
|
explicit `help`/`-h`, 2 for the bare no-args usage error)."""
|
|
del argv # help takes no arguments
|
|
w = sys.stderr.write
|
|
w(f"usage: {PROG} <command> [args...]\n\n")
|
|
w("Commands:\n")
|
|
w(" active list currently-running bot-bottle bottles\n")
|
|
w(" backend set up / check / undo a backend's host prerequisites (setup|status|teardown)\n")
|
|
w(" cleanup stop and remove all active bot-bottle containers\n")
|
|
w(" commit snapshot a running bottle's container state to a Docker image\n")
|
|
w(" edit open an agent in vim for editing\n")
|
|
w(" help show this command list\n")
|
|
w(" init interactively create a new agent and add it to bot-bottle.json\n")
|
|
w(" list list available agents from bot-bottle.json\n")
|
|
w(" login register this host with a bot-bottle console\n")
|
|
w(" resume re-launch a bottle by its identity (continues state from PRD 0016)\n")
|
|
w(" start boot a container for a named agent and attach an interactive session\n")
|
|
w(" supervise view + approve/modify/reject pending supervise proposals (PRD 0013)\n\n")
|
|
w(f"Run '{PROG} <command> --help' for command-specific usage.\n")
|
|
return 0
|