https://github.com/jedwards1230/libro-client
Library for downloading Libro.fm audiobooks
https://github.com/jedwards1230/libro-client
audiobooks docker librofm typescript
Last synced: over 1 year ago
JSON representation
Library for downloading Libro.fm audiobooks
- Host: GitHub
- URL: https://github.com/jedwards1230/libro-client
- Owner: jedwards1230
- License: mit
- Created: 2024-03-16T17:58:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-07T18:04:57.000Z (over 1 year ago)
- Last Synced: 2025-03-23T16:18:24.904Z (over 1 year ago)
- Topics: audiobooks, docker, librofm, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/libro-client
- Size: 17.3 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Libro.fm CLI Tool
This is a simple command-line tool for interacting with your Libro.fm library. It allows you to:
- List all audiobooks in your library
- Download audiobooks to your computer
- Check for new audiobooks in your library
- Run as a background service
## Command-line interface
### Installation
The CLI can be installed as a global package using npm:
```bash
bun add -g libro-client
```
To run the tool, use the following command:
```bash
libro
```
This will display a list of available commands.
### List audiobooks
To list all audiobooks in your library, run the following command:
```bash
libro list
```
This will print a list of audiobook titles to the console.
### Download audiobooks
To download a specific audiobook, run the following command:
```bash
libro get [...isbns]
```
To choose an audiobook from your library, run the following command:
```bash
libro get
```
Replace `[...isbns]` with the ISBN of the audiobook you want to download. You can find the ISBN by running the list command.
If you don't specify an ISBN, the tool will prompt you to select an audiobook from your library.
### Check for new audiobooks
To check for new audiobooks in your library, run the following command:
```bash
libro check
```
This will print a list of new audiobooks to the console. You can also use the --json flag to output the data as JSON.
## Background service
The tool can also be run as a background service. This is useful if you want to automatically download new audiobooks as they become available in your library.
To run the service, you can use Docker or another process manager.
### Docker
To run the service using Docker, use the following command:
```bash
docker build -t libro .
docker run -d libro
```
Or use the provided `docker-compose.yml` file:
```bash
docker-compose up -d
```
## Configuration
You can set the following environment variables:
```bash
DEBUG=false
LIBROFM_USERNAME=
LIBROFM_PASSWORD=
```
## Disclaimer
This tool is not affiliated with Libro.fm in any way. Use it at your own risk.