yume/matrix-dump
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add usage docs

Browse source 
Signed-off-by: eternal-flame-AD <yume@yumechi.jp>
This commit is contained in:
ゆめ 2024-09-04 22:35:04 -05:00
parent bd6d8625ed
commit e087326755
No known key found for this signature in database
2 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# matrix-dump
Matrix Protocol Dumper
## Usage
Sample command:
```sh
mkdir -p config
cargo run --release -- --username @eternal_flame:matrix.org -f alikia
```

9
src/lib.rs
View file

@ -43,7 +43,10 @@ pub struct Args {
#[clap(long, default_value = "Matrix.org Protocol Dumper by Yumechi")]
pub device_name: Option<String>,
#[clap(long)]
#[clap(
long,
help = "If you lost the token but still have the keys, specify the device ID here"
)]
pub device_id: Option<String>,
#[clap(long, default_value = "config/token.json")]
@ -52,7 +55,7 @@ pub struct Args {
#[clap(short, long, default_value = "dump")]
pub out_dir: String,
#[clap(long)]
#[clap(short, long, help = "Filter rooms by name or ID by substring")]
pub filter: Vec<String>,
#[clap(long, short = 'j', default_value = "4")]
@ -61,7 +64,7 @@ pub struct Args {
#[clap(long, default_value = "config/e2e.db")]
pub e2e_db: String,
#[clap(long)]
#[clap(long, help = "Read the password from a file")]
pub password_file: Option<String>,
#[clap(