https://github.com/sivefunc/vman
Vman - Video Man Pages from the Terminal
https://github.com/sivefunc/vman
json linux manpages python videos vman
Last synced: 3 months ago
JSON representation
Vman - Video Man Pages from the Terminal
- Host: GitHub
- URL: https://github.com/sivefunc/vman
- Owner: sivefunc
- License: other
- Created: 2025-06-18T23:58:44.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-08-08T16:46:31.000Z (11 months ago)
- Last Synced: 2025-10-14T13:35:37.810Z (8 months ago)
- Topics: json, linux, manpages, python, videos, vman
- Language: Python
- Homepage: https://pypi.org/project/vman/
- Size: 181 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# :shipit: vman
# :bookmark: Table of contents
1. [About](#about)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Options](#options)
5. [Files](#files)
6. [Supported Creators](#creators)
7. [Notes](#notes)
8. [The End](#end)
## :question: About
vman is a small but configurable CLI program to open helpful videos about linux utility commands from a variety of creators using the default media player in the system.
### :penguin: Binary dependencies (Debian)
```sh
sudo apt-get install python3 python3-pip python3-setuptools pipx
```
```sh
pipx ensurepath
```
### :snake: Option 1: Pypi
```sh
pipx install vman
```
### :hand: Option 2: Git repository (Still connects to Pypi)
```sh
pipx install git+https://github.com/sivefunc/vman.git
```
## :computer: Usage
usage: vman [video] [author] [options]
vman - Video Man Pages
### Open a video from distrotube
```sh
vman ls -a distrotube
```
### Change media player (by default it uses xdg-open)
```sh
vman ls -p mpv
```
### Pipe URL to a different program + verbose
```sh
vman ls --only-url --verbose | xargs librewolf
```
## :gear: Options
```sh
options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-a AUTHOR, --author AUTHOR
Author of the video to consult, e.g 'roberteldersoftware'
-p PATH, --player PATH
Path to media player to use instead of the one defined in config
--only-url Do not reproduce the video, returns the url
--urls List all the video manuals in JSON format
--verbose Detailed output at console
```
## :file_folder: Files
### Config File
TOML file that allows the user to modify the default options, e.g the media player.
It's located at src/vman/config.toml
example:
```toml
media_player = "xdg-open"
author = "distrotube"
[custom-urls]
enabled = false
path = ""
```
### URLS File
JSON File that maps an author to a collection of videos.
It's located at src/vman/urls.json but you can modify the location.
```json
{
"distrotube": {
"ls": "https://www.youtube.com/watch?v=T-4Q7i6mNeM"
},
"roberteldersoftware": {
"nice": "https://www.youtube.com/shorts/uuCYq64Ww7o",
"fmt": "https://www.youtube.com/shorts/SyylpFY_eSg"
}
}
```
## :camera: Supported Creators
Name
Profile Picture
DistroTube
RobertElderSoftware
## :notebook: Notes
- CLI Options have higher precedency than config.toml
## Made by :link: [Sivefunc](https://github.com/sivefunc)
## Licensed under :link: [GPLv3](https://github.com/sivefunc/vman/blob/master/LICENSE)
