Skip to content

Commit

Permalink
docs: better readme copy.
Browse files Browse the repository at this point in the history
  • Loading branch information
atombender authored Aug 18, 2022
1 parent 4de584b commit e214958
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,7 @@

# Usage

Tailing based on label:

```shell
$ ktail -l app=myapp
```

This will tail all containers in all pods matching the label `app=myapp`. As new pods are created, it will also automatically tail those, too.

It's also possible to filter on pod/container name. The following will match all containers whose pod name or container name contains the substring `foo`:
Ktail makes it super easy to tail by pod or container name. The following will match all containers whose pod name or container name contains the substring `foo`:

```shell
$ ktail foo
Expand All @@ -32,6 +24,14 @@ $ ktail '^foo'

If no filters are specified, _all_ pods in the current namespace are tailed.

Tailing supports the usual things like labels:

```shell
$ ktail -l app=myapp
```

This will tail all containers in all pods matching the label `app=myapp`. As new pods are created, it will also automatically tail those, too.

To abort tailing, hit `Ctrl+C`.

## Options
Expand Down

0 comments on commit e214958

Please sign in to comment.