Browse Source

Add readme and some tweaks to the cli arguments.

master
Roelf Wichertjes 2 years ago
parent
commit
1c08b07356
Signed by: rewby GPG Key ID: 4C2B6D2972EE5423
3 changed files with 31 additions and 2 deletions
  1. +1
    -1
      Cargo.toml
  2. +29
    -0
      README.md
  3. +1
    -1
      src/args.rs

+ 1
- 1
Cargo.toml View File

@@ -10,7 +10,7 @@ tokio = { version = "1.14.0", features = ["full"] }
anyhow = "1.0.51"
tracing = "0.1"
tracing-subscriber = "0.2"
clap = { version = "3.0.0-rc.0", features = ["derive"] }
clap = { version = "3.0.0-rc.0", features = ["derive", "env"] }
redis = { version = "0.21.4", features = ["tokio-comp"] }
futures = "0.3"
tokio-stream = { version = "0.1.8", features = ["io-util"] }


+ 29
- 0
README.md View File

@@ -0,0 +1,29 @@
# queuectl

Program to bulk-load items into redis queues.

Call it using `./queuectl -h` to see the instructions.
Note that the default redis url assumes the primary redis on blackbird is available on localhost using the default redis port.

Note that there is an environment variable set on blackbird that will make it just work ther eas well.

## Features
* Retrieve files from URLs
* ZSTD Decompression
* XZ Decompression
* GZIP Decompression
* Progress bar (can be disabled)

## Building
Install rust via rustup.
Enable the `x86_64-unknown-linux-musl` target architecture.
```sh
rustup target add x86_64-unknown-linux-musl
```
Now build the binary using:
```sh
cargo build --release --target=x86_64-unknown-linux-musl
```

The binary is now at `target/x86_64-unknown-linux-musl/release/queuectl`.
This is a static binary that can be copied around at will.

+ 1
- 1
src/args.rs View File

@@ -17,7 +17,7 @@ pub struct Cli {
#[clap(long, default_value = "8192")]
/// How many items to send per SADD command.
pub chunk_size: usize,
#[clap(long, default_value = "redis://127.0.0.1/")]
#[clap(short, long, default_value = "redis://127.0.0.1/", env = "TRACKER_REDIS_URL")]
/// URL of the redis to connect to.
pub redis: String,
#[clap(long, short, default_value = "auto", arg_enum)]


Loading…
Cancel
Save