https://github.com/wackystudio/forge-ssh-assistant

An assistant for SSH'ing into Laravel Forge servers
https://github.com/wackystudio/forge-ssh-assistant

Last synced: about 2 months ago
JSON representation

An assistant for SSH'ing into Laravel Forge servers

• Host: GitHub
• URL: https://github.com/wackystudio/forge-ssh-assistant
• Owner: WackyStudio
• License: mit
• Created: 2019-06-24T12:09:24.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-21T17:27:52.000Z (over 2 years ago)
• Last Synced: 2024-11-07T12:04:34.672Z (about 2 months ago)
• Language: PHP
• Size: 11.3 MB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Logo](logo.jpg)

[![Total Downloads](https://img.shields.io/packagist/dt/wackystudio/forge-ssh-assistant.svg?style=flat-square)](https://packagist.org/packages/wackystudio/forge-ssh-assistant)

Forge SSH Assistant is a CLI tool built with [Laravel Zero](https://laravel-zero.com) for macOS and Linux that fetches your Laravel Forge 

servers and lists these in a menu so you can easily choose which server you want to connect to using SSH.

With Forge SSH Assistant you don't have to open Laravel Forge to check the IP address of the server(s) you want to work with. 

You don't have to maintain aliases on every machine you use for development, all Forge SSH Assistant needs is a valid Laravel Forge token to be able to access your Laravel Forge account 

and fetch a list of your servers.

------

## Installation

You can install Forge SSH Assistant through Composer like this:

```bash

composer global require wackystudio/forge-ssh-assistant

```

This will install Forge SSH Assistant globally on your machine.

Make sure to add Composers global bin directory to your `$PATH` so the Forge SSH Assistant

can be accessed anywhere.

The Composer global bin directory is placed differently based on your operation system 

and some common locations are:

* macOS: `$HOME/.composer/vendor/bin`

* GNU / Linux Distributions: `$HOME/.config/composer/vendor/bin`

After the installation you will be able to run Forge SSH Assistant through the `forge` command.

### Adding a token

To be able to interact with one or more Laravel Forge account(s), Forge SSH Assistant needs a valid Laravel Forge token together with a name of the account the token belongs to.

To create a token you'll need to head into your account settings on Laravel Forge and choose **API** in the menu.

Here you should create a new token, you can name it whatever you want but we recommend that you name it 

`Forge SSH Assistant ` where you replace the `` with the actual name of your computer, 

such as `Office` or `MacBook Pro`

An overlay will open with the actual token, which you should copy. Make sure that you copy everything.

Go into your terminal and run the following command and replace the `` with the name of your token or the Forge account this belongs to and replace  ``

with the actual token you copied from Laravel Forge:

```bash

forge token:add  

```

To test that everything works, run the following command:

```bash

forge ssh

```

You should now be able to see the servers you have provisioned through Laravel Forge and select these to SSH into them.

## License

Forge SSH Assistant is an open-source software licensed 

under the [MIT license](https://raw.githubusercontent.com/WackyStudio/ForgeSSHAssistant/master/LICENSE.md).