Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hominee/dyer-cli

Handy tool for dyer
https://github.com/hominee/dyer-cli

Last synced: about 2 months ago
JSON representation

Handy tool for dyer

Awesome Lists containing this project

README

        

# Introduction
[Dyer-cli] is a great tool created to guide you use [dyer] fast and at ease, helps you build a robust crawler, data processor, netwrok program fast and correctly.

[Dyer-cli]: https://github.com/HomelyGuy/dyer-cli
[dyer]: https://github.com/HomelyGuy/dyer

# Installation
Dyer-cli is built completely by Rust programming language without extra dependencies, So rust must be installed beforehand, to test it with:
```bash
rustup --version
```
if you ever see some infomation like that
```bash
rustup 1.23.1 (3df2264a9 2020-11-30)
```
then you are ready to go, the following code would suffice.
```bash
cargo install dyer-cli
```
the command will download the source code and complie it to build a executable file inside your `$HOME/.cargo/bin`, make sure it's in your `$PATH`

# Commands
Dyer-cli provides some commands that helps you initialize, debug programm, more commands are to go.

## dyer new
This command helps you initialize a project with log level `Info`, other log levels vares from `Error`, `Warn`, `Info`, `Debug`, and `Trace`, and its structure is
```bash
|___Cargo.toml
|___Readme.md
|___data/
|___data/tasks/
|___src/
|___src/entity.rs
|___src/parser.rs
|___src/actor.rs
|___src/middleware.rs
|___src/pipeline.rs
```
## dyer check
Alias `dyer c`, A warper of `cargo check`, if you run it the first time,`dyer-cli` will download the crates and then check the code.

## dyer fix
Alias `dyer f`, A wraper of `cargo fix`, if some warning happens such as `unused import` or `dead code` the command does a lot for you. However it won't help if some errors occur, if so, you have to debug the code manually.

## dyer run
Alias `dyer r`, A wraper of `cargo run`, when the program compiles, run it.

## dyer build
Alias `dyer b`, A wraper of `cargo build`, build the program.

## dyer test
Alias `dyer t`, A wraper of `cargo test`, test the program.

## dyer clean
A wraper of `cargo clean`, clean the directory.