https://github.com/lapce/tiron
Reasonable Automation Engine
https://github.com/lapce/tiron
configuration-management infrastructure-automation remote-execution
Last synced: 8 months ago
JSON representation
Reasonable Automation Engine
- Host: GitHub
- URL: https://github.com/lapce/tiron
- Owner: lapce
- License: apache-2.0
- Created: 2024-04-04T21:24:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T14:03:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T20:48:06.361Z (11 months ago)
- Topics: configuration-management, infrastructure-automation, remote-execution
- Language: Rust
- Homepage: https://tiron.run
- Size: 162 KB
- Stars: 77
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tiron
**Reasonable Automation Engine**
**Tiron** is an automation tool that's easy to use and aims to be as fast as possible. It’s agentless by using SSH and has a TUI for the outputs of the tasks. There is an example Tiron configuration [here](https://github.com/lapce/tiron/tree/main/examples/example_tiron_project).
## Features
* **No YAML:** Tiron uses [HCL](https://github.com/hashicorp/hcl) as the configuration language.
* **Agentless:** By using SSH, Tiron connects to the remote machines without the need to install an agent first.
* **TUI:** Tiron has a built in terminal user interfaces to display the outputs of the running tasks.
* **Correctness:** Tiron pre validates all the runbook files and will throw errors before the task is started to execute.
* **Speed:** On validating all the input, Tiron also pre populates all the data for tasks, and send them to the remote machines in one go to save the roundtrips between the client and remote.
* **LSP:** Tiron provides a LSP server which can provide syntax highlighting, linting, formatting, code jumps, completion etc.
## Quickstart
Run below to install latest Tiron binary to ```/usr/local/bin```
```bash
curl -sL https://tiron.run/install.sh | sh
```
More information can be found in the [docs](https://tiron.run/docs/getting-started/overview/).
## Usage
To run a Tiron runbook
```console
$ tiron run
```
Full usage:
```console
$ tiron -h
A reasonable automation engine
Usage: tiron
Commands:
run Run Tiron runbooks
check Check Tiron runbooks
fmt Format Tiron runbooks
action Show Tiron action docs
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```
## TUI Navigation
| Key | Action |
| --------------------------------- | ------------ |
| j | Scroll down |
| k | Scroll up |
| d | Page down |
| u | Page up |
| g | Jump to top |
| G | Jump to bottom |
| n | Next Host |
| p | Previous Host |
| Ctrl+n | Next Run |
| Ctrl+p | Previous Run |
## License
Tiron is licensed under the Apache 2.0 license.