ghosler-cli
v1.0.90
Published
A basic, simple CLI for installing, managing Ghosler instances.
Downloads
8
Maintainers
Readme
Ghosler CLI
This is a CLI
project for managing Ghosler.
Pre-requisites
PM2
Node 18^
Ghosler-CLI uses PM2
as a process manager to handle Ghosler
.
Install
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:
ghosler restart --name xyz-site-com
.ghosler install --branch feature-branch-name
.ghosler logs --name xyz-site-com --type error
.