add cli section to README

This commit is contained in:
onyx-and-iris 2022-10-26 02:41:22 +01:00
parent b1a679f621
commit bacb281859

View File

@ -48,6 +48,8 @@ If you decide to direct download see [alternative instructions](FROM_SOURCE.md).
## Use ## Use
#### As a script file
When you instantiate Remote class you will automatically be logged in. Use a When you instantiate Remote class you will automatically be logged in. Use a
try finally block to ensure you logout at the end of your code. try finally block to ensure you logout at the end of your code.
@ -77,6 +79,27 @@ Voicemeeter factory function can be:
- Get-RemoteBanana - Get-RemoteBanana
- Get-RemotePotato - Get-RemotePotato
#### As a CLI
As well as storing scripts into files and running them you can invoke expressions straight through Powershell. A quick note, since you cannot Login more than
once in a single session you ought to run any commands through a subshell. Assuming you have installed as a module you could run this command:
```powershell
powershell { $vmr = Get-RemoteBasic; $vmr.strip[0].mute=$true; $vmr.Logout() }
```
Getters should also work, for example:
```powershell
# Print the value of strip 0 mute to console
powershell { $vmr = Get-RemoteBasic; Write-Host "Strip 0 mute =", $vmr.strip[0].mute; $vmr.Logout() }
# Toggle strip 0 mute
powershell { $vmr = Get-RemoteBasic; $vmr.strip[0].mute=!$vmr.strip[0].mute; $vmr.Logout() }
```
So you essentialy have a CLI.
### Strip ### Strip
The following strip commands are available: The following strip commands are available: