README Copy Section

Book Searcher

[](https://github.com/zu1k/book-searcher/stargazers)
[](https://github.com/zu1k/book-searcher/network)
[](https://github.com/zu1k/book-searcher/releases)
[](https://github.com/zu1k/book-searcher/issues)
[](https://github.com/zu1k/book-searcher/blob/master/LICENSE)

#### 中文版

Easy and blazing-fast book searcher, create and search your private library.

Book Searcher can index metadata for over 10 million books in one minute, and search in 30µs.

Usage Copy Chapter

We currently offer both Desktop and Command-line versions.
For individual users we recommend using the desktop version.

Desktop Copy Section

1. Download the pre-compiled desktop installer from Release

Or you can compile by yourself. Refer to Build from source section for instructions.

- Windows: Book-Searcher-desktop_version_x64.msi
- macOS: Book-Searcher-desktop_version_x64.dmg
- Linux:
- Deb: Book-Searcher-desktop_version_amd64.deb
- AppImage: Book-Searcher-desktop_version_amd64.AppImage

2. Prepare the index

Refer to Prepare the index section for instructions.

3. Run book-searcher-desktop

Specify the index folder path in the settings menu.

Cli Copy Section

1. Download the pre-compiled binary from Release

Or you can compile by yourself. Refer to Build from source section for instructions.

2. Prepare the index

Refer to Prepare the index section for instructions.

3. Run book-searcher run

It will listen to 127.0.0.1:7070.

Access http://127.0.0.1:7070/ to use webui, or you can use the original search api.

Deploy with Docker Copy Section

mkdir book-searcher && cd book-searcher
wget https://raw.githubusercontent.com/book-searcher-org/book-searcher/master/docker-compose.yml
Prepare the index: put csv files in the directory, and run the following command to create index

docker-compose run --rm -v "$PWD:$PWD" -w "$PWD" book-searcher /book-searcher index -f *.csv
start book-searcher

docker-compose up -d

Now book-searcher it will listen to 0.0.0.0:7070.

Deploy with Vercel / Netlify Copy Section

Deploying the frontend to Vercel / Netlify to speed up loading of static resources and provide a reverse proxy to the image service.

[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fbook-searcher-org%2Fbook-searcher%2Ftree%2Fmaster%2Ffrontend&project-name=book-searcher&repository-name=book-searcher)

[](https://app.netlify.com/start/deploy?repository=https://github.com/book-searcher-org/book-searcher&base=frontend)

Original Search Api Copy Section

You can search by the following fields:

- title
- author
- publisher
- extension
- language
- isbn
- id

Examples:

- /search?limit=30&offset=0&title=TITLE
- /search?limit=30&offset=0&title=TITLE&author=AUTHOR
- /search?limit=30&offset=0&isbn=ISBN
- /search?limit=30&offset=0&query=title:TITLE extension:epub publisher:PUBLISHER

We now have two search modes, /search?limit=30&offset=0&mode=explore&title=TITLE&author=AUTHOR

- filter: the results need to meet all restrictions, default mode
- explore: the results only need to meet certain restrictions

Build from source Copy Chapter

Build Cli version Copy Section

1. Build frontend

make frontend_preinstall frontend

2. Build book-searcher

TARGET=release make
move the compiled binary to the project root directory

mv target/release/book-searcher .

Build Desktop version Copy Section

1. Install frontend dependencies

make frontend_preinstall

2. Build book-searcher-desktop

cargo tauri build

Prepare the index index')" title="Copy section prompt for LLMs"> Copy Section

1. Prepare the raw data

Prepare the raw books metadata and save the csv files to the project root directory.

The raw data is used to generate the index, see Raw data section for details.

2. Create index

You may need to rm -rf index first.

book-searcher index -f *.csv

The finally folder structure should look like this:

book_searcher_dir
├── index
│   ├── some index files...
│   └── meta.json
└── book-searcher

Raw data Copy Chapter

This raw data is used to generate index, should be a csv file with the following fields:

id, title, author, publisher, extension, filesize, language, year, pages, isbn, ipfs_cid, cover_url, md5

You will need to export and maintain your own meta information for the books you have purchased, as this project only provides fast searching.

License Copy Chapter

book-searcher © The Book Searcher Authors, Released under the BSD-3-Clause License.

---