Skip to content

Commit

Permalink
update readmen
Browse files Browse the repository at this point in the history
  • Loading branch information
xrstf committed Mar 19, 2022
1 parent 06daf10 commit 051f48a
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ go install go.xrstf.de/stalk

```
Usage of ./stalk:
-c, --context-lines int number of context lines to show in diffs (default 3)
-w, --diff-by-line diff entire lines and do not highlight changes within words
-h, --hide stringArray path expression to hide in output (can be given multiple times)
--hide-managed Do not show managed fields (default true)
-j, --jsonpath string JSON path expression to transform the output (applied before the --show paths)
--kubeconfig string kubeconfig file to use (uses $KUBECONFIG by default)
-l, --labels string Label-selector as an alternative to specifying resource names
-n, --namespace string Kubernetes namespace to watch resources in (default "default")
-s, --show stringArray path expression to include in output (can be given multiple times) (applied before the --hide paths)
-e, --show-empty do not hide changes which would produce no diff because of --hide/--show/--jsonpath
-v, --verbose Enable more verbose output
-c, --context-lines int number of context lines to show in diffs (default 3)
-w, --diff-by-line diff entire lines and do not highlight changes within words
-h, --hide stringArray path expression to hide in output (can be given multiple times)
--hide-managed Do not show managed fields (default true)
-j, --jsonpath string JSON path expression to transform the output (applied before the --show paths)
--kubeconfig string kubeconfig file to use (uses $KUBECONFIG by default)
-l, --labels string Label-selector as an alternative to specifying resource names
-n, --namespace stringArray Kubernetes namespace to watch resources in (supports glob expression) (can be given multiple times)
-s, --show stringArray path expression to include in output (can be given multiple times) (applied before the --hide paths)
-e, --show-empty do not hide changes which would produce no diff because of --hide/--show/--jsonpath
-v, --verbose Enable more verbose output
```

## Examples
Expand All @@ -39,7 +39,8 @@ Usage of ./stalk:
stalk -n kube-system deployments
```

Would watch all Deployments in the `kube-system` namespace.
Would watch all Deployments in the `kube-system` namespace. You can give the `-n` flag multiple times
and it even supports glob expressions (e.g. `-n 'kube-*'`).

```bash
stalk -n kube-system deployments,statefulsets,configmaps
Expand All @@ -64,7 +65,8 @@ A label selector can be given. It will be applied to all given resource kinds.
stalk -n kube-system deployments kube-apiserver kube-controller-manager kube-scheduler
```

You can also list the resources you are interested in by name.
You can also list the resources you are interested in by name. You can give multiple names
and they support glob expressions.

```bash
stalk -n kube-system deployments --hide-managed-fields=false
Expand Down

0 comments on commit 051f48a

Please sign in to comment.