goatshell 2023.9.21.1932

goatshell - goat shell interface to common cloud providers.

GOATSHELL

7 Clouds & 1 Shell

Installation

Manual Installation

1. Create a virtual environment. We will call it prod:

   python3 -m venv ~/prod
   

2. Activate virtual environment:

   cd ~/prod && source bin/activate
   

3. Clone the repo:

   git clone [e-mail]:stacksc/goat.git
   

4. Install all required packages with 1 script from the main repository:

   cd ~/prod/goat && ./bulk.sh --action rebuild --target all
   

PIP installation (stable)

1. Install the following packages from pypi:

   pip install goatshell goaat --force-reinstall
   

2. Type the following command to launch goatshell:

   goatshell
   

┌───────────────────────────────────────────────────────────────────────────────────────────────────────| GOAT INTERFACE |───────────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                                     Purpose: Cloud Wrapper                                                                                                     │
│                                                                                             TIP: resource completion coming soon!                                                                                              │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
┌────────| Hotkeys |─────────┐┌─────────────| Advanced |─────────────┐┌────────| Commands |────────┐
│[F9]  Toggle VI mode        ││history   : shell history             ││e|exit    : exit shell      │
│[F10] Toggle Profile        ││!<cmd>    : run OS command            ││c|clear   : clear screen    │
│[TAB] Fuzzy Complete        ││cloud     : view cloud details        ││h|help    : display usage   │
└────────────────────────────┘└──────────────────────────────────────┘└────────────────────────────┘

    Auto-Completion Instructions:
    ----------------------------
    1. To trigger auto-completion, start with TAB or type the beginning of a command or option and press Tab.
    2. Auto-completion will suggest available commands, options, and arguments based on your input.
    3. Use the arrow keys or Tab to navigate through the suggestions.
    4. Press Enter to accept a suggestion or Esc to cancel.
    5. If an option requires a value, use --option=value instead of --option value.
    6. The prompt will change dynamically based on cloud provider interaction.

[oci:DEFAULT]>

(back to top)

Contacts

Christopher Stacks - [e-mail]

Mechanics

The project is built with dependecies such as aws2, oci-cli, az-cli.
However, other cloud providers are configured to work but NOT packaged with the project such as ibmcloud, gcloud, and Alibaba cloud.

Each time the first token is passed (i.e. cloud provider) a function will verify if the command is avialable.
This keeps the command line clean with the cloud providers you only work with.

The following cloud providers are currently supported:

Toolbar

The toolbar will refresh after hitting the ENTER key or with specific hotkeys.

The toolbar is updated appropriately based on what command you ran. Once you run a command, the toolbar is refreshed with your current cloud.

The profile is updated dynamically based on your current cloud and you have the ability to toggle profiles for any cloud.

goat>
Current Cloud: AWS  F8 Usage F10 Toggle Profile: CENTERUPT F12 Quit

Toggle

The only toggle currently supported is profile switching. Everything else is dynamic based on first token.

Cloud CLI Options

#	Name	Status	Additional Info
1	OCI-CLI	Default / Supported
2	AWS	Default / Supported
3	AZ	Default / Supported
4	GCLOUD	Supported / Manual Installation	Installation Guide
5	ALIYUN	Supported / Manual Installation	Installation Guide
6	IBMCLOUD	Supported / Manual Installation	Installation Guide

Once the relative CLI is installed, the goatshell application will recognize that it is available & syntax completion will be provided.
The project is packaged with cloud provider JSON files which get refreshed automatically per major release with dynamic CLI scrapers.

As the first token is passed (i.e. cloud provider) it directs the goatshell application to the correct JSON file.