https://github.com/itznotabug/ghosler-cli

A basic, simple CLI for installing, managing a Ghosler instance.
https://github.com/itznotabug/ghosler-cli

Last synced: about 1 month ago
JSON representation

A basic, simple CLI for installing, managing a Ghosler instance.

• Host: GitHub
• URL: https://github.com/itznotabug/ghosler-cli
• Owner: ItzNotABug
• License: apache-2.0
• Created: 2023-12-18T12:33:40.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-03-29T07:20:29.000Z (8 months ago)
• Last Synced: 2024-10-08T16:00:33.606Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 214 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## Ghosler CLI

This is a `CLI` project for managing [Ghosler](https://github.com/itznotabug/ghosler).

### Pre-requisites

1. `PM2`

2. `Node 18^`

Ghosler-CLI uses `PM2` as a process manager to handle `Ghosler`.

### Install

```npm

npm i ghosler-cli -g

```

### Commands

| Command             | Description                                                                                                                                 |

|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------|

| `ghosler ls`        | List all the registered processes with `PM2`.                                                                                               |

| `ghosler install`   | Install Ghosler from its GitHub source.
Option: `--branch` where the value can be `release` or `name-of-the-branch`. Default: `release`. |

| `ghosler update`    | Check and update Ghosler if available.                                                                                                      |

| `ghosler restart`   | Restart Ghosler if you made any changes to source.                                                                                          |

| `ghosler flush`     | Flush all of Ghosler Logs.                                                                                                                  |

| `ghosler backup`    | Backup Ghosler instance (Directory backup).                                                                                                 |

| `ghosler uninstall` | Remove Ghosler, its all data and configurations completely.
 **Note: Download your local backups before uninstalling Ghosler.**         |

| `ghosler logs`      | Print logs for Ghosler.
Option: `--type` where values can be `error`, `out`. Default: `out`.                                             |

| `ghosler migrate`   | Perform migration if the latest release requires one.                                                                                       |

Note: If there are multiple processes, you must specify the process/instance name to perform any of the above

operations.

Examples:

1. `ghosler restart --name xyz-site-com`.

2. `ghosler install --branch feature-branch-name`.

3. `ghosler logs --name xyz-site-com --type error`.