https://github.com/rubixdev/pixterm
A CLI to show images in a terminal
https://github.com/rubixdev/pixterm
cli rust
Last synced: about 1 year ago
JSON representation
A CLI to show images in a terminal
- Host: GitHub
- URL: https://github.com/rubixdev/pixterm
- Owner: RubixDev
- License: gpl-3.0
- Created: 2021-12-07T22:03:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-06T18:30:45.000Z (about 3 years ago)
- Last Synced: 2025-02-28T06:59:44.079Z (about 1 year ago)
- Topics: cli, rust
- Language: Rust
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# pixterm
A CLI to show images in a terminal
## Usage
`pixterm [FLAGS] [OPTIONS] `
### Arguments
| name | description |
| ------ | ----------------------------- |
| `file` | Path to image file to display |
### Flags
| short | long | description |
| ----- | ----------- | ----------------------------------------------- |
| `-h` | `--help` | Prints help information |
| `-r` | `--raw` | Print escape sequences literal |
| `-s` | `--silent` | Do not print to stdout. Useful with `--outfile` |
| `-V` | `--version` | Prints version information |
### Options
| short | long | description | default |
| ----- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | ------- |
| `-W` | `--width` | Maximum width in pixels of the resized image. Also see `--height` | 32 |
| `-H` | `--height` | Maximum height in pixels of the resized image. Also see `--width` | 32 |
| `-o` | `--outfile` | File to write the resulting string into. See `--raw` to get literal escape sequences and `--silent` to suppress stdout | None |
| `-t` | `--threshold` | Minimum alpha value of a pixel for it to be shown | 50 |