-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mutiple File Paths for "skip" directive, and Implemented "Manual Rest…
…art" Listener.
- Loading branch information
1 parent
2c39a9c
commit 73d74b6
Showing
3 changed files
with
44 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,88 +1,88 @@ | ||
# GLIVE | ||
|
||
▄████ ██▓ ██▓ ██▒ █▓ █████ | ||
██▒ ▀█ ██▒ ▓██▒ ██░ █▒ █ ▀ | ||
▒██░▄▄▄ ▒██░ ▒██▒ ▓██ █▒ ███ | ||
░▓█ ██ ▒██░ ░██░ ▒██ █░░▒▓█ ▄ | ||
░▒▓███▀▒░██████ ░██░ ▒▀█░ ▒████▒ | ||
░▒ ▒ ░ ▒░▓ ░ ▓ ░ ▐░ ░░ ▒░ ░ | ||
░ ░ ░ ░ ░ ▒ ░ ░░ ░ | ||
░ ░ ░ ░ ░ ░ | ||
|
||
|
||
## Directory and File Watcher && Live Server :: Similar to NODEMON, But can work with any platform. | ||
### You can watch any Directroy and keep any Process Alive. Enjoy!! | ||
## Directory / File Watcher & Process Reloader | ||
|
||
My reason to write this, was being able to have the instructions in a file: as part of `git`, and just run a one word command, to start the server and start building. Since I would always forget the command, this saves me a lot of hassle, every day when setting up the dev environment. Also when running, multi threaded processes like `Fiber` or `Gin` servers, had problems closing properly with other solutions out there, and would use too much memory after a few restarts. | ||
|
||
## Features: | ||
* You can use with any platform like Nodejs, Golang, Python etc. | ||
* Run any command and Watch any directory. | ||
* Skip Directory or Files. | ||
* Super fast, as built in Golang. | ||
* Easy installation. | ||
* No dependencies. | ||
* Colorfull Info Prompts for readability. | ||
* Available as a debian package. | ||
* Free to use. | ||
|
||
## Usage: | ||
```sh | ||
SYNTAX: | ||
glive -d <directory to be Watched.> -c "command to run" -s "<path to skip>" - Optional. | ||
|
||
EXAMPLES: | ||
glive -d . -c "go run ./main.go" | ||
glive -d . -c "go run ./cmd/app/main.go" | ||
glive -d ./src -c "node src/app/index.js" | ||
glive -d /tmp -c "python script.py" -s "/.git" | ||
glive -d ./directory -c "./binary" -s "./logs" | ||
glive -d ../. -c "any command" | ||
|
||
- You can use with any platform like Nodejs, Golang, Python etc. | ||
- Watch any directory. | ||
- Run Multi Threaded processes like Fiber / Gin / Other ... | ||
- Skip Directories or Files. | ||
- Super fast, as built in Golang. | ||
- Easy installation. | ||
- No dependencies. | ||
|
||
## Example Config File: | ||
|
||
Create a `glive.json` file in working directory like below. | ||
|
||
```json | ||
{ | ||
"watch": "./", | ||
"command": "go run ./cmd/app1/main.go", | ||
"skip": ["./logs", ".git", "./offProject/notes.md", "glive.json", "./docs"] | ||
} | ||
``` | ||
|
||
## Usage: | ||
|
||
`glive` to Run,`rs` "while running" For Manually Restart,`Ctrl+c` To Stop | ||
|
||
## Installation | ||
|
||
### Method A: | ||
>Using the Debian Package Manager / apt / apt-get. | ||
#### 1. Downlaod the "Binary File": | ||
|
||
> Using the Debian Package Manager / apt / apt-get. | ||
#### 1. Downlaod the "Debian Pkg": | ||
|
||
```sh | ||
wget curl https://github.com/clubcleaver/glive/raw/main/glive.deb | ||
sudo apt install ./glive.deb | ||
``` | ||
|
||
#### 2. Use GLIVE | ||
|
||
```sh | ||
glive | ||
``` | ||
|
||
--- | ||
|
||
### Mehod B: | ||
>Manual Install | ||
|
||
> Manual Install | ||
#### 1. Downlaod the "Binary File": | ||
|
||
```sh | ||
curl -O https://github.com/clubcleaver/glive/raw/main/glive | ||
``` | ||
|
||
###### OR | ||
|
||
``` | ||
wget curl https://github.com/clubcleaver/glive/raw/main/glive | ||
``` | ||
|
||
#### 2. Change file permissions | ||
|
||
```sh | ||
chmod 777 ./glive | ||
``` | ||
|
||
#### 3. Add the file location to your $PATH. | ||
|
||
```sh | ||
export $PATH=$PATH:<path-to-glive-file> | ||
``` | ||
|
||
#### 4. Use GLIVE | ||
|
||
```sh | ||
glive | ||
``` | ||
--- | ||
|
||
|
||
|
||
## Reason | ||
Flexibility to use any directory and run any type of file at any location,s using one package. | ||
|
||
### Hope you like using GLIVE | ||
--- |