https://github.com/anupam-git/paradox
A neat tool to run scripts on Server from Remote Clients
https://github.com/anupam-git/paradox
nodejs pkg remote script
Last synced: 8 months ago
JSON representation
A neat tool to run scripts on Server from Remote Clients
- Host: GitHub
- URL: https://github.com/anupam-git/paradox
- Owner: anupam-git
- License: mit
- Created: 2018-09-25T07:32:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-25T19:12:38.000Z (about 7 years ago)
- Last Synced: 2025-04-15T16:17:58.114Z (8 months ago)
- Topics: nodejs, pkg, remote, script
- Language: TypeScript
- Size: 42 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Paradox
A neat tool to run scripts on a Server from Remote Clients.
Paradox is written in NodeJS and shipped as standalone executables for Linux, [unfortunately ;)] Windows and MacOS.
### Install
No need to build from source code unless you absolutely want to.
Grab the latest version from the [GitHub Releases](https://github.com/anupam-git/paradox/releases).
### How it works
To run scripts on the server, you need to first add scripts.
```
./paradox add-script
```
The Clients need to authenticate to run scripts. To create user use the following command
```
./paradox add-user <username> <password>
```
Once the scripts and users are added, you can start the Paradox Server to listen to requests from Clients.
```
./paradox start-server <host> <port>
```
From Clients, use the `run-script` command to run scripts on the remote server
```
./paradox run-script -u <username> -p <password> <host> <port> <script-name>
```
This will invoke the script at Server and exit.
If you want to receive the output of the scriptm then invoke the `run-scrupt` command with the `-w, --wait-for-output` option
```
./paradox run-script -u <username> -p <password> <host> <port> <script-name>
```
# Want To Treat Me? :)
If you want to show some love, you can Treat Me via Paypal. :)
[](https://paypal.me/AnupamBasak)
# Documentation
```
Usage: paradox [options] [command]
Options:
-v, --version output the version number
-h, --help output usage information
Commands:
start-server <host> <port> Start Paradox Server
add-user <username> <password> Add User to Paradox Server
remove-user <username> Remove User from Paradox Server
add-script <name> <script> Register a Script for Paradox Server [Requires Restart]
remove-script <name> Removes a Registered Script from Paradox Server [Requires Restart]
list-scripts <host> <port> Show List of Available Remote Scripts
run-script [options] <host> <port> <script-name> Run Script on Remote Paradox Server
reset-config Resets the Paradox Server to initial state [Requires Restart]
```
## start-server
```
Usage: start-server [options] <host> <port>
Start Paradox Server
Options:
-h, --help output usage information
```
## add-user
```
Usage: add-user [options] <username> <password>
Add User to Paradox Server
Options:
-h, --help output usage information
```
## remove-user
```
Usage: remove-user [options] <username>
Remove User from Paradox Server
Options:
-h, --help output usage information
```
## add-script
```
Usage: add-script [options] <name> <script>
Register a Script for Paradox Server [Requires Restart]
Options:
-h, --help output usage information
```
## remove-script
```
Usage: remove-script [options] <name>
Removes a Registered Script from Paradox Server [Requires Restart]
Options:
-h, --help output usage information
```
## list-scripts
```
Usage: list-scripts [options] <host> <port>
Show List of Available Remote Scripts
Options:
-h, --help output usage information
```
## run-script
```
Usage: run-script [options] <host> <port> <script-name>
Run Script on Remote Paradox Server
Options:
-w, --wait-for-output [Optional] Waits for output of Script
-u, --username <username> [Required]
-p, --password <password> [Required]
-h, --help output usage information
```
## reset-config
```
Usage: reset-config [options]
Resets the Paradox Server to initial state [Requires Restart]
Options:
-h, --help output usage information
```