https://github.com/neomantra/tempted
Temporal Textual User Interface
https://github.com/neomantra/tempted
Last synced: 4 months ago
JSON representation
Temporal Textual User Interface
- Host: GitHub
- URL: https://github.com/neomantra/tempted
- Owner: neomantra
- License: mit
- Created: 2023-04-20T20:46:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-21T09:05:32.000Z (about 2 years ago)
- Last Synced: 2024-06-21T18:12:18.005Z (12 months ago)
- Language: Go
- Size: 86.9 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# tempted - Temporal Text User Interface
`tempted` is a TUI (Textual User Interface) for [Temporal](https://temporal.io/). It is an CLI alternative to [`tctl`](https://github.com/temporalio/tctl), seeking to give an interative experince like the [Temporal Web UI](https://docs.temporal.io/web-ui).
* Currently tracking [this GitHub issue](https://github.com/temporalio/tctl/issues/359)
## Usage
```
$ tempted --help
tempted is a terminal application for Temporal. It is used to
view workflows, and more, all from the terminal in a productivity-focused UI.
Usage:
tempted [flags]
tempted [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
serve Start ssh server for tempted
Flags:
-a, --address string Nomad address. Default "localhost:7233"
-c, --config string Config file path. Default "$HOME/.tempted.yaml"
--help Print usage
-n, --namespace string Temporal namespace. Default "default"
-u, --update string Seconds between updates for workflow pages. Disable with "-1". Default "5"
-v, --version version for tempted
```
## Environment Variables
The following environment variables affect program runtime:
| Name | Default | Description |
| --- | --- | --- |
| `TEMPORAL_CLI_ADDRESS` |"localhost:7233:7234" | `host:port` for Temporal frontend service |
## Installing
Binaries for multiple platforms are [released on GitHub](https://github.com/neomantra/tempted/releases) through [GitHub Actions](https://github.com/neomantra/tempted/actions).
You can also install for various platforms with [Homebrew](https://brew.sh) from [`neomantra/homebrew-tap`](https://github.com/neomantra/homebrew-tap):
```
brew tap neomantra/homebrew-tap
brew install tempted
```
----
## SSH App
`tempted` can be served via ssh application. For example, you could host an internal ssh application for your company such that anyone on the internal network can `ssh -p ` and immediately access `tempted` without installing or configuring anything.
Serve the ssh app with `tempted serve`.
----
## Building
Building is performed with [task](https://taskfile.dev/):
```
$ task
```
----
## Credits and License
This Text Application is not only inspired by [`wander`](https://github.com/robinovitch61/wander), a similar tool for [HashiCorp Nomad](https://nomadproject.io). The entire initial implementation was copied, then I ported an initial spike working in a few hours!
This software is released with the same license as [Temporal](https://github.com/temporalio/temporal/blob/master/LICENSE), with gratitude to and no affiliation with [Temporal.io](https://temporal.io) and [Charm.sh](https://charm.sh) and [robinovitch61](https://github.com/robinovitch61).
Copyright (c) 2023 [Neomantra BV](https://www.neomantra.com). Authored by Evan Wies.
Released under the [MIT License](https://en.wikipedia.org/wiki/MIT_License), see [LICENSE.txt](./LICENSE.txt).