Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jlesquembre committed Nov 5, 2019
1 parent e2287b3 commit b5ad28d
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,33 @@ variable `SHELL`, starting a `bash` shell if is not defined.

Valid flags:

- `-p`, `--print-only` print if kubeprompt is enabled, don't do anything if not
- `-p`, `--print-only` print context information only kubeprompt is enabled,
don't do anything if not
- `-f`, `--force` print without checking if kubeprompt is enabled
- `-m`, `--monochrome` disables colors in output
- `-c`, `--check` print information about kubeprompt status
- `-h`, `--help` help for kubeprompt
- `-v`, `--version` print the version

## Workflows

There are 2 possible workflows

**Show information only after enable it**

In this case, you call `kubeprompt -p` in your dot files. To display information
about the current kubernetes context, you must call `kubeprompt` manually to
enable it. One advange with this aproach is that you can we confident about the
information in your terminal, since every terminal will have its own kubeconfig.

**Always show information**

In this case, you call `kubeprompt -f` in your dot files. The advantage here is
that you don't need to enable _kubeprompt_ manually, and the information will be
always in your prompt. But you cannot know for sure if the information is
accurate. Since your kubeconfig is global, other applications (or yourself in
other terminal) can change the global kubernetes context.

## F.A.Q.

### Why to copy kubeconfig and start a sub shell?
Expand Down

0 comments on commit b5ad28d

Please sign in to comment.