https://github.com/everettraven/buoy
A declarative Kubernetes dashboard in your terminal
https://github.com/everettraven/buoy
containers dashboard declarative-ui developer-tools devops-tools kubernetes kubernetes-dashboard kubernetes-ui tui
Last synced: 8 months ago
JSON representation
A declarative Kubernetes dashboard in your terminal
- Host: GitHub
- URL: https://github.com/everettraven/buoy
- Owner: everettraven
- License: apache-2.0
- Created: 2023-10-14T19:10:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-15T12:46:37.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T13:22:21.863Z (over 1 year ago)
- Topics: containers, dashboard, declarative-ui, developer-tools, devops-tools, kubernetes, kubernetes-dashboard, kubernetes-ui, tui
- Language: Go
- Homepage: https://everettraven.github.io/buoy/
- Size: 172 KB
- Stars: 66
- Watchers: 3
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - everettraven/buoy - A declarative Kubernetes dashboard in your terminal (<a name="Go"></a>Go)
README
# buoy
`buoy` is a declarative TUI dashboard for Kubernetes. You define your dashboard in a JSON file and it will fetch the information from your Kubernetes cluster and build a dashboard for viewing the requested content right in your terminal window.
> [!NOTE]
> This project is in the extremely early stages of development and is a hobby project. Use at your own risk.
[](https://asciinema.org/a/625808)
## Motivation
I created `buoy` because I do a lot of work on Kubernetes controllers. When I am making changes, I often find myself typing out a bunch of the same `kubectl ...` commands and switching between them.
Some of those commands are blocking (i.e `kubectl get logs -f ...`) and to keep them running while running other commands required opening a new terminal window and more typing.
Since I was running pretty repetitive commands I thought there had to be a better solution. I looked through existing CLI tooling around this space, but none had a simple interface that followed the pattern of
"define what you want to see and I'll show it to you". Thus `buoy` was created to fill this gap (and save me some time while delaying the inevitable arthritis).
## Quickstart
Install `buoy` by downloading one of the binaries from the [releases](https://github.com/everettraven/buoy/releases) or by running:
```sh
go install github.com/everettraven/buoy@latest
```
Load a dashboard with:
```sh
buoy
```
## General Controls
- `ctrl+c`, `q` will quit the program and exit the tui
- `tab` will switch the active tab to the one to the right of the currently active tab
- `shift+tab` will switch the active tab to the one to the left of the currently active tab
- `ctrl+h` will open a more detailed help menu
## Contributing
While this is a hobby project and in the early development stages, I'm more than happy to accept contributions. If you use `buoy` and find some problems or have some ideas for features/improvements, file an issue. If you want to contribute code, feel free to pick up any unassigned issues and create a pull request.
Since this is a hobby project responses to issues and/or pull requests are likely to be slow.