README
¶
servcli
Purpose
The "Command line server manager" project is a command line application designed to facilitate server management. Its main objective is to allow users to select a specific server from a list based on various customizable criteria.
This application provides a user-friendly command line interface that allows users to view and browse a list of available servers. Users will be able to specify criteria such as geographic location, availability, processing capacity, current load, or any other attribute relevant to their specific environment.
Through a combination of intuitive commands and advanced filters, users will be able to quickly narrow down the list of available servers to their specific needs. Once the server is selected, actions such as SSH connection, remote command execution or resource management can be performed easily.
The "Command line server manager" aims to improve the efficiency and ease of server management, providing administrators and users with a powerful tool to access and manipulate servers more quickly and accurately.
Build instructions
If you're new to Go, check out "How to Build and Install Go Programs"
Running the Program
navigate to the root directory of the project and run either go run . to run the program or go build to build the
program binary. If you built the binary, you can run it with ./project-management or even add it to your PATH so you
can just run project-management from anywhere.
Configuration
For the moment, the configuration is only possible through a yaml file. The program will take by default the one named
./config/servcli-config.yaml. But it is possible to provide your own file with the --config option.
The list of servers will be described in a file in yaml format with the following scheme:
server_list:
Entity1:
description: Small description for Entity1
elements:
group1:
- name: e1g1serv1
isaws: false
- name: e1g1serv2
isaws: true
- name: e1g1serv3
isaws: false
group2:
- name: e1g2serv1
isaws: true
- name: e1g2serv2
isaws: false
- name: e1g2serv3
isaws: true
ssh_command: ssh -T [email protected] %s
Collaboration
You're welcome to write features and report issues for this project.
Documentation
¶
Overview ¶
Copyright © 2023 NAME HERE <EMAIL ADDRESS>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories