https://github.com/newtoallofthis123/refresh
A Simple Auto Builder CLI for your Applications
https://github.com/newtoallofthis123/refresh
cli refresh rust-cli server
Last synced: 2 months ago
JSON representation
A Simple Auto Builder CLI for your Applications
- Host: GitHub
- URL: https://github.com/newtoallofthis123/refresh
- Owner: newtoallofthis123
- License: mit
- Created: 2023-09-05T12:21:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T14:24:14.000Z (almost 3 years ago)
- Last Synced: 2025-02-28T07:57:51.038Z (over 1 year ago)
- Topics: cli, refresh, rust-cli, server
- Language: Rust
- Homepage: https://crates.io/crates/refrsh
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Refresh
A Simple and easy to use hot reload tool for your projects.
## What is Refresh?
Refresh is a very _simple_ cli written in rust that does one thing and one thing only: **Reload your project when any file changes**.
Atleast by default it does that. I am planning to add more features to it in the future.
For now, you can use refresh on your:
- Rust projects
- Go projects
Other than that, you can free to contribute and add support for your own language or toolchain.
## How to use Refresh?
For now, using refresh is very simple. Just install it using cargo:
```bash
cargo install refresh
```
And then run it in your project directory:
```bash
refresh
```
Where `` is the directory you want to watch for changes. If you don't specify a directory, it will watch the current directory.
## How does Refresh work?
Refresh uses the [notify](https://crates.io/crates/notify) crate to watch for changes in the specified directory.
Refresh automatically picks up on which tool chain and language you are using and runs the appropriate command to build your project.
For example, if you are using rust, refresh will run `cargo build` on your project. If you are using go, refresh will run `go build` on your project.
However, if just run `refresh` in a directory, if refresh doesn't find an appropriate command to run, it will just exit.
## How to contribute?
If you want to add support for your own language or toolchain, you can do so by modifying the `src/handler.rs` file.
For example, the rust handler looks like this:
```rust
fn handle_cargo(){
bunt::println!("Building...");
let _ = std::process::Command::new("cargo")
.arg("build")
.output()
.expect("Failed to build");
bunt::println!("{$green}Build Successful{/$}");
}
```
You can add your own handler in the same way. Just add a new function and call it in the `handle` function.
If you want to add support for a new language, you can do so by adding a new function in the same way.
Well, there is more to it and I will add more documentation in the future. For now, you can just look at the source code and figure it out.
## License
Refresh is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.