get-zush-commands

Get zush commands

List the commands zush can dispatch on this machine. zush resolves zush a.b.c from two static indexes: pyindex.json (Python-package plugins, built by zush rebuild) and repoindex.json (repo plugins, built by zush sync), checking pyindex first.

Canonical reference:

• https://github.com/ZackaryW/zush/blob/main/docs/cli.md

Procedure

1. Prefer the CLI. If zush is on PATH, this lists every indexed command:

   zush --help
   

2. Fall back to the index JSON when zush is not installed / not on PATH. Both index files have a top-level "commands" object keyed by the dotted command path, so the keys are the runnable commands. Read both:

   # Python-package commands  (override path with $ZUSH_INDEX)
   jq -r '.commands | keys[]' ~/.zush/pyindex.json
   
   # repo (script) commands   (override path with $ZUSH_REPO_INDEX)
   jq -r '.commands | keys[]' ~/.zush/repoindex.json
   

   Honor the env overrides if set: ZUSH_INDEX for the Python index and ZUSH_REPO_INDEX for the repo index. A missing file just means that index has not been built yet — report it, do not treat it as an error.

3. For detail on one command, read its record from the index (each value under .commands carries package, file, func, args, and opts):

   jq '.commands["git.clean"]' ~/.zush/pyindex.json
   

Notes

• The indexes are static snapshots of the last build. If a command is missing, the index may be stale — zush rebuild re-indexes Python plugins, zush sync <repo> re-indexes a repo plugin.
• Dispatch resolves pyindex.json first, then repoindex.json; an unknown path reports no such command.