root
26f6122ca2
Describe the filter focus rules, the column scrolling keys, and the error and catalogue failure behaviour. Add the install, run and develop sections pointing at the new Makefile targets.
73 lines
1.6 KiB
Markdown
73 lines
1.6 KiB
Markdown
# cctuip
|
|
|
|
> Co-op Cloud 🎉
|
|
|
|
This is a prototype to gather some feedback.
|
|
|
|
## Features
|
|
|
|
* `abra app ls` compatibility. It does not query `-S` unless you press
|
|
`s` (like passing `-S` on the CLI) so that initial loading times are
|
|
real fast (because we only query local-first data in `~/.abra`).
|
|
|
|
* Fuzzy search against domain, server and recipe.
|
|
|
|
## Controls
|
|
|
|
* `up/down`: scroll up / down (`jk` vim bindings also work)
|
|
* `page up/down`: page up / page down (`ctrl+u/d` vim bindings also work)
|
|
* `home`/`g`: jump to the first row
|
|
* `end`/`G`: jump to the last row
|
|
* `shift+left`/`shift+right`: scroll between columns when they overflow
|
|
* `/` or `f`: fuzzy filter against domain, server & recipe
|
|
* `enter` or `esc`: confirm the filter and return focus to the table (`esc`
|
|
also clears it)
|
|
* `s`: retrieve app deployment status (filter first to reduce scope)
|
|
* `q` or `ctrl+c`: quit
|
|
|
|
Servers are queried at most five at a time, so a large fleet does not open one
|
|
SSH connection per server all at once.
|
|
|
|
### Errors
|
|
|
|
Unreachable servers (e.g. SSH login issues) are skipped and reported in a
|
|
banner; statuses for the remaining servers are still shown. The banner shows
|
|
the first few problems and a count of the rest. Press any key to dismiss it
|
|
and try again.
|
|
|
|
If the recipe catalogue cannot be fetched, the deployment statuses are still
|
|
rendered and only the `Updates` column is left unknown.
|
|
|
|
## Install
|
|
|
|
```
|
|
make install
|
|
```
|
|
|
|
or, with Go installed:
|
|
|
|
```
|
|
go install coopcloud.tech/cctuip@latest
|
|
```
|
|
|
|
## Run
|
|
|
|
```
|
|
make run
|
|
```
|
|
|
|
or:
|
|
|
|
```
|
|
go run .
|
|
```
|
|
|
|
## Develop
|
|
|
|
```
|
|
make check # gofmt and go vet
|
|
make test # unit tests
|
|
make format # apply gofmt
|
|
make build # build ./cctuip
|
|
```
|