Michel de Graaf
14b0321dbc
The READMEs still described the flags and spellings the one-shot rework replaced, and said nothing about `skills`. The root README gains an agent skills section covering install, update and removal; the crate READMEs catch up with the current command set, record shapes and library API.
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
# soulseek-rs
|
|
|
|
A Soulseek client for the terminal: a full-screen TUI, and a one-shot command
|
|
surface built for scripts and agents.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
cargo install soulseek-rs
|
|
```
|
|
|
|
## Usage
|
|
|
|
Run it with no subcommand for the interactive TUI:
|
|
|
|
```bash
|
|
soulseek-rs
|
|
```
|
|
|
|
Anything else is a one-shot command that runs headless. stdout carries records
|
|
only, stderr carries progress, and the exit code carries the verdict:
|
|
|
|
```bash
|
|
soulseek-rs search <QUERY> # print matching files
|
|
soulseek-rs get <QUERY> # search, pick the best, download
|
|
soulseek-rs download <USER> <PATH> # fetch one known file
|
|
soulseek-rs download --stdin # fetch files listed on stdin
|
|
soulseek-rs browse <USER> # list a user's shared files
|
|
soulseek-rs serve [--follow] # stay online sharing, stream uploads
|
|
soulseek-rs whoami # confirm credentials and connection
|
|
soulseek-rs user <NAME> # a peer's status and share counts
|
|
soulseek-rs room list|say|users|listen
|
|
soulseek-rs message send|read
|
|
soulseek-rs shares list|add|remove|status|reindex
|
|
soulseek-rs config path|list|get|set
|
|
soulseek-rs portmap # test automatic port mapping
|
|
```
|
|
|
|
Add `--json` for newline-delimited JSON instead of tab-separated text, so
|
|
commands compose:
|
|
|
|
```bash
|
|
soulseek-rs search "rjd2" --json \
|
|
| jq -c 'select(.size > 5000000 and .free_slot)' \
|
|
| soulseek-rs download --stdin
|
|
```
|
|
|
|
Exit codes: `0` success, `2` usage or config, `3` connect or login, `4` nothing
|
|
found, `5` timed out, `6` transfer failed, `1` unexpected error.
|
|
|
|
The [full README](https://github.com/michel/soulseek-rs#readme) documents every
|
|
command, record shape, flag, environment variable and `config.toml` key.
|
|
|
|
## Building from Source
|
|
|
|
```bash
|
|
git clone https://github.com/michel/soulseek-rs.git
|
|
cd soulseek-rs
|
|
cargo build --release
|
|
```
|
|
|
|
## Library
|
|
|
|
To build your own Soulseek client, use the
|
|
[soulseek-rs-lib](https://crates.io/crates/soulseek-rs-lib) crate: the protocol
|
|
implementation this client is built on.
|