Difference between revisions of "CLI"
(Created page with "Use command line arguments interact with Screenbits through command line interface (CLI). == Commands == Screenbits supports the following commands: {|class="wikitable" ! st...") |
(→Arguments) |
||
| Line 29: | Line 29: | ||
|- | |- | ||
|background | |background | ||
| − | | | + | |Keeps the app in the background while executing the command. |
|} | |} | ||
Revision as of 13:47, 24 May 2024
Use command line arguments interact with Screenbits through command line interface (CLI).
Commands
Screenbits supports the following commands:
| Command | Description |
|---|---|
| start | Starts recording |
| stop | Stops recording |
| pause | Pauses recording |
| resume | Resumes recording |
Arguments
The following arguments can be used along with commands:
| Argument | Description |
|---|---|
| background | Keeps the app in the background while executing the command. |
Usage (Packaged)
Use protocol activation to activate screenbits protocol to run a command for a packaged installation of Screenbits in the following form:
start screenbits://[command]/?arg[=value]
The following example starts recording without bringing the app to foreground:
start screenbits://record/?background
You can also use explorer program instead of start command to activate a protocol if you need to specify an executable file to launch the command. This is useful for creating tasks in scheduler programs such as Windows Task Scheduler:
explorer screenbits://record/?background
Usage (Non-Packaged)
To run a command for a non-packaged installation of Screenbits, simply pass the command and arguments to the application executable:
[path-to-executable]screenbits.exe [command -[arg[=value]]]
The following example starts recording without bringing the app to foreground:
"C:\Program Files (x86)\Steam\steamapps\common\Screenbits\screenbits.exe" record -background