Skip to content

Fix pkg cat docs source to match generated output #4536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liamfallon merged 1 commit into from
May 21, 2026
+17 −8
Merged

Fix pkg cat docs source to match generated output #4536

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions documentation/content/en/reference/cli/pkg/cat/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@ title: "`cat`"
linkTitle: "cat"

description: |
Print the resources in a file/directory
Print the contents of a package
---

<!--mdtogo:Short
Print the resources in a file/directory
Print the contents of a package
-->

`cat` prints the resources in a file or directory as yaml to stdout.
`cat` prints the contents of a package to stdout. KRM resources (YAML/JSON)
are formatted as YAML, while non-KRM text files are printed raw. Outputs are
separated by document separators.

### Synopsis

Expand All @@ -24,8 +26,10 @@ kpt pkg cat [FILE | DIR]

```shell
FILE | DIR:
Path to a directory either a directory containing files with KRM resources, or
a file with KRM resource(s). Defaults to the current directory.
Path to a file or a directory containing a kpt package. Displays all
package files: KRM resources (YAML/JSON) are formatted by default,
and non-KRM text files (e.g., README.md) are shown as raw content.
Binary files are skipped. Defaults to the current directory.
```

<!--mdtogo-->
Expand Down Expand Up @@ -54,13 +58,18 @@ FILE | DIR:
<!--mdtogo:Examples-->

```shell
# Print resource from a file.
# Print all package contents from current directory.
$ kpt pkg cat
```

```shell
# Print a single resource file.
$ kpt pkg cat path/to/deployment.yaml
```

```shell
# Print resources from current directory.
$ kpt pkg cat
# Print a non-KRM file.
$ kpt pkg cat path/to/README.md
```

<!--mdtogo-->