Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radj307 authored Jul 30, 2022
1 parent 343564c commit a8efac9
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,34 @@
# Volume Control CLI
<p align="center">
<a href="https://github.com/radj307/volume-control-cli"><img src="https://i.imgur.com/lTPPocx.png"></a><br/>
<a href="https://github.com/radj307/volume-control-cli/releases/latest"><img alt="Latest Tag Shield" src="https://img.shields.io/github/v/tag/radj307/volume-control-cli?label=Version&logo=github&style=flat-square"></a>&nbsp;&nbsp;&nbsp;<a href="https://github.com/radj307/volume-control-cli/releases"><img alt="Total Downloads Shield" src="https://img.shields.io/github/downloads/radj307/volume-control-cli/total?label=Downloads&logo=github&style=flat-square"></a>
</p>

***

Commandline app-specific volume control utility for Windows.
**Supports both Audio Input & Output Devices**

This is the commandline version of **[Volume Control](https://github.com/radj307/volume-control)**, which adds fully configurable & extensible hotkeys for controlling the mixer volume level of specific apps *(and much more)*.


## Features

- Get & set the volume level of specific programs or device endpoints.
- Mute & unmute specific programs or device endpoints.
- View the ProcessId & ProcessName of all active audio sessions.
- Custom flexible GNU-style syntax.
- Supports minimal I/O for shell scripts. (`-q`|`--quiet`)
- Built-in documentation (`vccli -h`).
- Supports both Audio Input & Audio Output Devices
- Supports changing the volume/mute state of specific processes
- View the ProcessId & ProcessName of all active audio sessions
- Interactive device/session queries (`-Q`|`--query`)
- Custom flexible GNU-style syntax
- Supports minimal I/O for shell scripts (`-q`|`--quiet`)
- Built-in documentation (`vccli -h`)


## Installation

1. Download the [latest release](https://github.com/radj307/vccli).
2. Extract to a location of your choice. *Preferably [somewhere on your PATH](https://stackoverflow.com/a/44272417/8705305) if you want to invoke `vccli` from any working directory.*
2. Extract to a directory of your choice.

> ### :warning: Important
> If you want to be able to call `vccli` from any working directory without specifying the full path, you'll have to add the directory where you placed `vccli.exe` to [your PATH environment variable](https://stackoverflow.com/a/44272417/8705305).
> Once you've done that, restart your terminal emulator to refresh its environment & you'll be able to call `vccli` from anywhere.
## Usage

Expand Down

0 comments on commit a8efac9

Please sign in to comment.