Problem
When a shiv package is installed, humans and agents often want to read its package README without remembering where shiv placed the checkout.
Today the workaround is something like:
cat "$(shiv which <package>)/README.md"
That is discoverable only if you already know the package layout.
Proposed command
Add:
Behavior:
- resolve the installed package checkout using the same package lookup as other shiv commands;
- find
README.md / README in the package root;
- print it to stdout by default;
- optionally render Markdown nicely for humans when stdout is a TTY, e.g. via
gum format if available;
- fail clearly if the package is not installed or has no README.
Scope guardrail
Keep the first version focused on README access. Package metadata/querying is related but should be a follow-up, not part of the first implementation.
A possible later direction: let packages expose metadata in mise.toml using mise's generic _ sections, similar to existing [_.codebase] usage, then add commands to inspect that metadata. That should not block shiv readme.
Origin: https://github.com/ricon-family/or/issues/98
Problem
When a shiv package is installed, humans and agents often want to read its package README without remembering where shiv placed the checkout.
Today the workaround is something like:
cat "$(shiv which <package>)/README.md"That is discoverable only if you already know the package layout.
Proposed command
Add:
Behavior:
README.md/READMEin the package root;gum formatif available;Scope guardrail
Keep the first version focused on README access. Package metadata/querying is related but should be a follow-up, not part of the first implementation.
A possible later direction: let packages expose metadata in
mise.tomlusing mise's generic_sections, similar to existing[_.codebase]usage, then add commands to inspect that metadata. That should not blockshiv readme.Origin: https://github.com/ricon-family/or/issues/98