Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d3witt/viking
Simple way to manage your remote machines and SSH keys
https://github.com/d3witt/viking
bare-metal cli deploy deployment remote-access-tool servers ssh ssh-key ssh-keys ssh-tunnel vm
Last synced: about 1 month ago
JSON representation
Simple way to manage your remote machines and SSH keys
- Host: GitHub
- URL: https://github.com/d3witt/viking
- Owner: d3witt
- License: mit
- Created: 2024-07-28T15:01:39.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T07:59:29.000Z (about 1 month ago)
- Last Synced: 2024-08-10T09:05:47.602Z (about 1 month ago)
- Topics: bare-metal, cli, deploy, deployment, remote-access-tool, servers, ssh, ssh-key, ssh-keys, ssh-tunnel, vm
- Language: Go
- Homepage:
- Size: 78.1 KB
- Stars: 244
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Viking 🗺️
### Simple way to manage your remote machines
Bare metal servers are awesome. They let you pick where to run your software and how to deploy it. You get full control to make the most of the server's resources. No limits, no compromises. That's real freedom.
Viking makes it easier to work with them.
```
NAME:
viking - Manage your SSH keys and remote machines
USAGE:
viking [global options] command [command options]
VERSION:
v1.0
COMMANDS:
exec Execute shell command on machine
key Manage SSH keys
machine Manage your machines
config Get config directory path
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```
## 🚀 Installation
See [releases](https://github.com/d3witt/viking/releases) for pre-built binaries.
On Unix:
```
env CGO_ENABLED=0 go install -ldflags="-s -w" github.com/d3witt/viking@latest
```
On Windows cmd:
```
set CGO_ENABLED=0
go install -ldflags="-s -w" github.com/d3witt/viking@latest
```
On Windows powershell:
```
$env:CGO_ENABLED = '0'
go install -ldflags="-s -w" github.com/d3witt/viking@latest
```
## 📄 Usage
#### 🛰️ Add machine:
```
$ viking machine add --name deathstar --key starkey 168.112.216.50
Machine deathstar added.
```
> [!NOTE]
> The key flag is not required. If a key is not specified, SSH Agent will be used to connect to the server.
#### 📡 Exec command:
```
$ viking exec deathstar echo 1234
1234
```
#### 📺 Connect to the machine:
```
$ viking exec --tty deathstar /bin/bash
root@deathstar:~$
```
#### 🗂️ Machine group:
```
$ viking machine add -n dev -k starkey 168.112.216.50 117.51.181.37 24.89.193.43 77.79.125.157
Machine dev added.
$ viking exec dev echo 1234
168.112.216.50: 1234
117.51.181.37: 1234
24.89.193.43: 1234
77.79.125.157: 1234
```
> [!NOTE]
> All machines in the group will run the same command at the same time. If there are errors, they will show up in the output. The execution will keep going despite the errors.
#### 🔑 Add SSH key from a file
```
$ viking key add --name starkey --passphrase dart ./id_rsa_star
Key starkey added.
```
#### 🆕 Generate SSH Key
```
$ viking key generate --name starkey2
Key starkey2 added.
```
#### 📋 Copy public SSH Key
```
$ viking key copy starkey2
Public key copied to your clipboard.
```
#### ⚙️ Custom config directory
Viking saves data locally. Set `VIKING_CONFIG_DIR` env variable for a custom directory. Use `viking config` to check the current config folder.
## 🤝 Missing a Feature?
Feel free to open a new issue, or contact me.
## 📘 License
Viking is provided under the [MIT License](https://github.com/d3witt/viking/blob/main/LICENSE).