mirror of
https://github.com/kubeshark/kubeshark.git
synced 2026-07-10 09:00:15 +00:00
27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# mizu CLI
|
|
## Usage
|
|
`./mizu {pod_name_regex}`
|
|
|
|
### Optional Flags
|
|
|
|
| flag | default | purpose |
|
|
|----------------------|------------------|--------------------------------------------------------------------------------------------------------------|
|
|
| `--no-dashboard` | `false` | Don't host the dashboard (not applicable at the moment) |
|
|
| `--dashboard-port` | `3000` | local port that dashboard will be forwarded to |
|
|
| `--namespace` | | use namespace different than the one found in kubeconfig |
|
|
| `--kubeconfig` | | Path to custom kubeconfig file |
|
|
|
|
There are some extra flags defined in code that will show up in `./mizu --help`, these are non functional stubs for now
|
|
|
|
## Installation
|
|
Make sure your go version is at least 1.11
|
|
1. cd to `mizu/cli`
|
|
2. Run `go mod download` (may take a moment)
|
|
3. Run `go build mizu.go`
|
|
|
|
Alternatively, you can build+run directly using `go run mizu.go {pod_name_regex}`
|
|
|
|
|
|
## Known issues
|
|
* mid-flight port forwarding failures are not detected and no indication will be shown when this occurs
|