A command line program to view and browse PeerTube, inspired by the youtube-viewer utility
This readme provides a quick overview of peertube-viewer-rs.
To learn how to install peertube-viewer, see the download page . To learn how to use it, see the documentation.
Compiling requires a rust toolchain to be installed, newer that v1.74.
cargo build --locked --releaseThe executable can then be found in target/release/peertube-viewer-rs, while autocompletion for a few shells will be found in in the completions directory.
peertube-viewer-rs hasn't been tested on any platform other than linux. Don't hesitate to open issues for bugs on other platforms.
Here is an example of basic usage :
The user wants to use the PeerTube instance video.ploud.fr. They search for videos about mastodon then they select the first search result. Additional information about the video is displayed and the video is launched. If no player has been chosen as argument and no player is selected in the config file, it will default to mpv to play the video. When the video has ended, the user can search other videos, play another search result or quit with :q.
For a more detailed usage description, checkout the documentation
To see all available options see:
peertube-viewer-rs -hor read the manpage
Don't hesitate to report bug or to request new features in the issue tracker
If you have a feature idea submit an issue to discuss it. If you want to contribute, merge requests are welcome. If you want to contribute, do not hesitate to take a look at the features that will be added in the issue tracker The master branch is the latest released version, while the development happens on the dev branch.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in peertube-viewer-rs by you, shall be licensed as AGPLv3, without any additional terms or conditions.