Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/joeri-abbo/rocket-cli

Rocket CLI: A user-friendly command-line tool for managing and launching SSH connections with optional proxy support.
https://github.com/joeri-abbo/rocket-cli

cli connection-management networking proxy python ssh ssh-client terminal

Last synced: about 2 months ago
JSON representation

Rocket CLI: A user-friendly command-line tool for managing and launching SSH connections with optional proxy support.

Host: GitHub
URL: https://github.com/joeri-abbo/rocket-cli
Owner: Joeri-Abbo
Created: 2023-05-03T22:03:39.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-10-04T08:31:24.000Z (over 1 year ago)
Last Synced: 2023-10-04T18:02:02.359Z (over 1 year ago)
Topics: cli, connection-management, networking, proxy, python, ssh, ssh-client, terminal
Language: Python
Homepage:
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: readme.md

# Rocket CLI Tool

Rocket is a command-line interface tool for managing SSH connections. It simplifies the process of adding, launching,
and deleting connections.

## Installation

1. Create a virtual environment and activate it:

```bash
python3 -m venv venv
source venv/bin/activate
```

2. Install the required packages:

```bash
2. pip install -r requirements.txt
```

3. Make the `main.py` file executable:

```bash
chmod +x main.py
```

4. Move and rename the `main.py` file to `/usr/local/bin/rocket`:

```bash
sudo mv main.py /usr/local/bin/rocket
```

Now, you can run the Rocket CLI tool by simply typing `rocket` in the terminal.

## Usage

1. Set the default username:

```bash
rocket install
```

2. Add a connection:

```bash
rocket add --username --host [--nickname ] [--through-proxy]
```

3. Add a proxy:

```bash
rocket add-proxy --username --host [--nickname ]
```

4. Launch a connection:

```bash
rocket launch []
```

5. Delete all connections and configuration:

```bash
rocket delete
```

## Unit Tests

Run the unit tests with:

```bash
python -m unittest test_rocket.py
```

With these changes, users will be able to run the Rocket CLI tool directly from their terminal by typing rocket followed
by the desired subcommand.