hull show readme

hull show readme prints a package’s README to stdout.

When to use it

• Read a package’s install notes and configuration guidance from the terminal.
• Pipe the README into a Markdown renderer or pager.

What happens

1. Looks in <package-path> for README.md, then README.txt, then README, and prints the first one it finds verbatim.
2. If none exists, exits with the error no README found in package.

The path may be a directory or a hull archive; no cluster is contacted.

Usage

hull show readme <package-path>

Flags

Inherits the global flags.

Worked example

INPUT — webapp/README.md on disk:

# webapp

Install notes for the webapp package.

OUTPUT (hull show readme webapp) — the file’s contents, unchanged:

# webapp

Install notes for the webapp package.

Pipe it through a renderer for nicer display, for example hull show readme webapp | glow -.

See also

• show — the show command index
• show all — chart, values, and README together
• show chart — the package metadata