Difference between revisions of "CLI"

From User Manual :: Screenbits
Jump to: navigation, search
(Arguments)
(Usage (Packaged))
Line 38: Line 38:
 
start screenbits://[command]/?arg[=value]
 
start screenbits://[command]/?arg[=value]
 
</code>
 
</code>
 
  
 
The following example starts recording without bringing the app to foreground:
 
The following example starts recording without bringing the app to foreground:
Line 45: Line 44:
 
start screenbits://record/?background
 
start screenbits://record/?background
 
</code>
 
</code>
 
  
 
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 [https://en.wikipedia.org/wiki/Windows_Task_Scheduler  Windows Task Scheduler]:
 
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 [https://en.wikipedia.org/wiki/Windows_Task_Scheduler  Windows Task Scheduler]:

Revision as of 13:50, 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 Command is executed without bringing the app to foreground.

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