Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alajmo/sake
:robot: sake is a task runner for local and remote hosts
https://github.com/alajmo/sake
cli config golang server ssh
Last synced: about 2 months ago
JSON representation
:robot: sake is a task runner for local and remote hosts
- Host: GitHub
- URL: https://github.com/alajmo/sake
- Owner: alajmo
- License: mit
- Created: 2021-10-09T10:00:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T20:47:11.000Z (about 1 year ago)
- Last Synced: 2024-08-01T02:29:48.284Z (4 months ago)
- Topics: cli, config, golang, server, ssh
- Language: Go
- Homepage: https://sakecli.com
- Size: 2.06 MB
- Stars: 640
- Watchers: 8
- Forks: 24
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-repositories - alajmo/sake - :robot: sake is a task runner for local and remote hosts (Go)
- awesome-go-extra - sake - 10-09T10:00:47Z|2022-08-25T17:25:40Z| (Go Tools / Other Software)
README
sake
`sake` is a command runner for local and remote hosts. You define servers and tasks in `sake.yaml` file and then run the tasks on the servers.
This readme is also accessible on [sakecli.com](https://sakecli.com/).
`sake` has tons of features:
- auto-completion of tasks, servers and tags
- SSH into servers or docker containers `sake ssh `
- list servers/tasks via `sake list servers|tasks`
- present task output in a compact table format `sake run --output table`
- open task/server in your preferred editor `sake edit task `
- import other `sake.yaml` configs
- and [many more!](docs/recipes.md)
Interested in managing your git repositories in a similar way? Check out [mani](https://github.com/alajmo/mani)!
## Table of Contents
- [Installation](#installation)
- [Building From Source](#building-from-source)
- [Usage](#usage)
- [Create a New Sake Config](#create-a-new-sake-config)
- [Run Some Commands](#run-some-commands)
- [Documentation](#documentation)
- [License](#license)
## Installation
[](https://repology.org/project/sake/versions)
`sake` is available on Linux and Mac.
* Binaries are available on the [release](https://github.com/alajmo/sake/releases) page
* via cURL
```sh
curl -sfL https://raw.githubusercontent.com/alajmo/sake/main/install.sh | sh
```
* via Homebrew
```sh
brew tap alajmo/sake
brew install sake
```
* via MacPorts
```sh
sudo port install sake
```
* via Arch
```sh
pacman -S sake
```
* via pkg
```sh
pkg install sake
```
* Via Go
```sh
go install github.com/alajmo/sake@latest
```
Auto-completion is available via `sake completion bash|zsh|fish` and man page via `sake gen`.
### Building From Source
Requires [go 1.19 or above](https://golang.org/doc/install).
1. Clone the repo
2. Build and run the executable
```sh
make build && ./dist/sake
# To build for all target platforms run (requires goreleaser CLI)
make build-all
```
## Usage
### Create a New Sake Config
Run the following command:
```bash
$ sake init
Initialized sake in /tmp/sake
- Created sake.yaml
Following servers were added to sake.yaml
Server | Host
-----------+---------
localhost | 0.0.0.0
```
### Run Some Commands
```bash
# List all servers
$ sake list servers
Server | Host
-----------+---------
localhost | 0.0.0.0
# List all tasks
$ sake list tasks
Task | Description
------+-------------
ping | Pong
# Run Task
$ sake run ping --all
TASK ping: Pong ************
0.0.0.0 | pong
# Count number of files in each server in parallel
$ sake exec --all --output table --strategy=free 'find . -type f | wc -l'
Server | Output
-----------+--------
localhost | 1
```
### What's Next
Check out the [examples page](/docs/examples.md) for more advanced examples and the [recipes page](/docs/recipes.md) for a list of useful recipes.
## Documentation
- [Examples](docs/examples.md)
- [Recipes](docs/recipes.md)
- [Config Reference](docs/config-reference.md)
- [Command Reference](docs/command-reference.md)
- Documentation
- [Inventory](docs/inventory.md)
- [Task Execution](docs/task-execution.md)
- [Error Handling](docs/error-handling.md)
- [Variables](docs/variables.md)
- [Working Directory](docs/work-dir.md)
- [Output](docs/output.md)
- Project
- [Background](docs/background.md)
- [Roadmap](docs/roadmap.md)
- [Ansible](docs/ansible.md)
- [Performance](docs/performance.md)
- Development
- [Development](docs/development.md)
- [Contributing](docs/contributing.md)
- [Changelog](docs/changelog.md)
## [License](LICENSE)
The MIT License (MIT)
Copyright (c) 2022 Samir Alajmovic