Skip to content

Commit 5ab1a5e

Browse files
authored
Update README.md
1 parent 3a6a594 commit 5ab1a5e

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,99 @@
11
# BAZARR BULK CLI
22

33
A CLI tool for performing actions in bulk on Bazarr movies and tv shows.
4+
List of supported actions:
5+
- sync
6+
- ocr-fixes
7+
- common-fixes
8+
- remove-hearing-impaired
9+
- remove-style-tags
10+
- reverse-rtl
411

512
## Installation
613

14+
### Install with cargo
15+
16+
[bazarr-bulk](https://crates.io/crates/bazarr-bulk) is published on crates.io.
17+
In order to install a Rust crate from crates.io, it is required to have [Rust and cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html) on your system.
18+
19+
```sh
20+
cargo install bazarr-bulk
21+
```
22+
23+
### Manual installation from an archive
24+
25+
[Latest release](https://github.com/mateoradman/bazarr-bulk/releases/latest) page provides an option to manually install the bb binary from an archive. The archive is available for Linux, MacOS, and Windows.
26+
Download, extract and move the binary to the desired directory, and set execution permissions.
27+
28+
#### Linux
29+
30+
1. Download the Linux tar.gz archive from the latest [release](https://github.com/mateoradman/bazarr-bulk/releases/latest)
31+
2. Extract the archive
32+
33+
```sh
34+
tar xf bazarr-bulk_*_x86_64-unknown-linux-musl.tar.gz
35+
```
36+
37+
3. Move the binary
38+
39+
```sh
40+
sudo mv bb /usr/local/bin
41+
```
42+
43+
4. Set execution permissions
44+
45+
```sh
46+
sudo chmod +x /usr/local/bin/bb
47+
```
48+
49+
5. Run bb
50+
51+
```sh
52+
bb --help
53+
```
54+
55+
#### MacOS
56+
57+
1. Download the MacOS (apple-darwin) ZIP archive from the latest [release](https://github.com/mateoradman/bazarr-bulk/releases/latest)
58+
2. Extract the archive
59+
60+
```sh
61+
unzip bazarr-bulk_*_x86_64-apple-darwin.zip
62+
```
63+
64+
3. Move the binary
65+
66+
```sh
67+
sudo mv bb /usr/local/bin
68+
```
69+
70+
4. Set execution permissions
71+
72+
```sh
73+
sudo chmod +x /usr/local/bin/bb
74+
```
75+
76+
5. Run bb
77+
78+
```sh
79+
bb --help
80+
```
81+
82+
#### Windows
83+
84+
1. Download the Windows ZIP archive from the latest [release](https://github.com/mateoradman/bazarr-bulk/releases/latest)
85+
2. Extract the archive
86+
3. Run bb.exe
87+
88+
789
## Usage
90+
1. Create a JSON config file based on the template [file](./examples/config.json).
91+
2. Run `bb --config your-config.json` [movies|tv-shows] [ACTION]
892

93+
### General help
994
```bash
95+
bb --help
96+
1097
Usage: bb --config <FILE> <COMMAND>
1198

1299
Commands:

0 commit comments

Comments
 (0)