https://github.com/around25/shellbot

Dead simple provisioning tool written in Go
https://github.com/around25/shellbot

Last synced: 11 months ago
JSON representation

Dead simple provisioning tool written in Go

• Host: GitHub
• URL: https://github.com/around25/shellbot
• Owner: Around25
• License: bsd-3-clause
• Created: 2016-01-04T17:49:47.000Z (over 10 years ago)
• Default Branch: develop
• Last Pushed: 2016-01-10T08:53:33.000Z (over 10 years ago)
• Last Synced: 2025-05-15T16:17:18.481Z (about 1 year ago)
• Language: Go
• Size: 22.5 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Shellbot

========

[![Join the chat at https://gitter.im/Around25/shellbot](https://badges.gitter.im/Around25/shellbot.svg)](https://gitter.im/Around25/shellbot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Shellbot allows the user to connect to any server through ssh and setup a certain infrastructure configuration

by running various commands on the remote server or by copying data from the host through SCP.

Installation

------------

Download the appropriate release for your architecture and start using it.

Usage

-----

__Copy Command__

Using the copy command you can copy a file or directory from the local host to a server and vice versa.

In order to user the command you must first have a configuration file that defines the list of managed servers.

To copy from local host to a server named dev-1 use this command: `$> shellbot --config ./shellbot/devops.yaml copy ./hosts.txt dev:/etc/hosts`

To download from a server use this command: `$> shellbot --config ./shellbot/devops.yaml copy dev:/etc/hosts ./hosts.txt`

__Shell Command__

Connect to a particular server using ssh use this command: `$> shellbot --config ./shellbot/devops.yaml shell dev-1`

__Setup Command__

To execute all tasks for the "dev" environment use this command: `$> shellbot --config ./shellbot/devops.yaml setup dev`

__Check Command -- NOT YET IMPLEMENTED__

The check command allows you to see if all servers for an environment are in their correct state.

Contributing

------------

In order to install all dependencies for the project run `make deps`.

To compile and install the `shellbot` tool run `make`.

In order to execute the tests run `make test` or `make test-coverage` in case you want to see the code coverage as well.