Reference

AdbOrc commands are organized into subcommands. There are four types of subcommands:

1. System commands
2. MarketMaker commands
3. Supplier commands
4. Consumer commands

The marketmaker, supplier and consumer commands are prefixed with the respective role. For example, adborc marketmaker start starts the marketmaker. The system commands are not prefixed with any role. For example, adborc init initializes the system.

The system commands are used to initialize the system and interact with system as a whole. The marketmaker commands are used to start the system in MarketMaker mode and interact with the marketmaker. Similarly, the supplier and consumer commands are used to start the system in Supplier and Consumer mode and interact with the respective roles.

System Commands

Following are the system commands and their usage:

init

adborc init

Starts the system listener service. This command must be run before any other command.

status

adborc status

Get the current status of the system. Returns if the system is initialized, and if it is, the mode(s) currently active.

shutdown

adborc shutdown

Shutdown the system. Terminates all active modes (MarketMaker / Supplier / Consumer).

get-network-id

adborc get-network-id

Get the network_id of system.

check

adborc check

Check if adb and scrcpy are installed and compatible. Outputs which modes (MarketMaker / Supplier / Consumer) are available to be run on the system.

set-adb-path

adborc set-adb-path <path>

Set the path to the adb executable, if not already in PATH. The specified path must be an absolute path to the adb executable.

For example: C:\Users\user\Downloads\platform-tools_r30.0.4-windows\adb.exe

set-scrcpy-path

adborc set-scrcpy-path <path>

Set the path to the scrcpy executable, if not already in PATH. The specified path must be an absolute path to the scrcpy executable.

For example: C:\Users\user\Downloads\scrcpy-win64-v1.17\scrcpy.exe

Marketmaker Commands

Following are the marketmaker commands and their usage.

Use adborc marketmaker <command> help for more information on each.

start

adborc marketmaker start

Start a network by running MarketMaker mode on the system.

stop

adborc marketmaker stop

Terminate the MarketMaker on the system.

WARNING: This will terminate the entire network of Suppliers and Consumers connected to the MarketMaker.

status

adborc marketmaker status

Get the current status of MarketMaker.

use-whitelist

adborc marketmaker use-whitelist

Enable MarketMaker whitelisting for authenticating Suppliers and Consumers. When whitelisting is enabled, only Suppliers and Consumers whose network_id (See: get-network-id) is added to the whitelist will be able to connect to the network.

Use add-supplier and add-consumer to add Suppliers and Consumers to the whitelist. Whitelist is disabled by default.

reset-whitelist

adborc marketmaker reset-whitelist

Remove the whitelisting requirement for Suppliers and Consumers.

add-supplier

adborc marketmaker add-supplier <peer-id>

Add a Supplier to the whitelist. The peer-id is the network_id of the Supplier.

remove-supplier

adborc marketmaker remove-supplier <supplier-id>

Remove a Supplier from the whitelist. The supplier-id is the network_id of the Supplier.

Note: This will not terminate the Supplier from the network if it is already connected to the MarketMaker.

add-consumer

adborc marketmaker add-consumer <peer-id>

Add a Consumer to the whitelist. The peer-id is the network_id of the Consumer.

remove-consumer

adborc marketmaker remove-consumer <peer-id>

Remove a Consumer from the whitelist. The peer-id is the network_id of the Consumer.

Note: This will not terminate the Consumer from the network if it is already connected to the MarketMaker.

Supplier Commands

Following are the supplier commands and their usage.

Use adborc supplier <command> help for more information on each.

start

adborc supplier start <Marketmaker_IP> [-s/--secure] [-u/--user <username>]

Connect to a network (MarketMaker) and start Supplier mode on the system

If secure is specified, the Supplier will be started in secure mode and encrypted tunnels will be used for all device communications with the Consumer.

If user is specified, the specified username will be used to identify the Supplier in the network. If not specified, the Supplier will be identified by its ip address. This is for representation purposes only and does not affect the functionality of the Supplier.

stop

adborc supplier stop

Terminate Supplier mode on the system. Supplier will be removed from the network and all supplied devices will be reclaimed.

status

adborc supplier status

Get the current status of Supplier.

supply

adborc supplier supply [--devices "serial1,serial2,..."]

Supply devices to the network.

If devices is not specified, all connected devices will be supplied.

reclaim

adborc supplier reclaim <device-id> [-f/--force]

Reclaim a device from the network. If the device is currently being used by a Consumer, the reclaim will fail unless force is specified.

Consumer Commands

Following are the consumer commands and their usage.

Use adborc consumer <command> help for more information on each.

start

adborc consumer start <Marketmaker_IP> [-u/--user <username>]

Connect to a network (MarketMaker) and start Consumer mode on the system.

If user is specified, the specified username will be used to identify the Consumer in the network. If not specified, the Consumer will be identified by its ip address. This is for representation purposes only and does not affect the functionality of the Consumer.

stop

adborc consumer stop

Terminate Consumer mode on the system. Consumer will be removed from the network and all reserved devices will be added back to the network.

status

adborc consumer status

Get the current status of Consumer.

list-available

adborc consumer list-available

Get a list of available devices in the network.

get-devices

adborc consumer get-devices [--is-available <true/false>] [--device-ids <"id1,id2,...">] \
 [--device-names <"name1,name2,...">] [--device-models <"model1,model2,...">] \
 [--supplied-by <"supplier1,supplier2,...">] [--reserved-by <"consumer1,consumer2,...">]

Get devices in the network and filter them by some criteria.

If is_available is true, only available devices will be returned. If is_available is false, only reserved devices will be returned. If is_available is not specified, all devices will be returned.

If device_ids is specified, only devices with the specified ids will be returned.

If device_names is specified, only devices with the specified names will be returned.

If device_models is specified, only devices with the specified models will be returned.

If supplied_by is specified, only devices supplied by the specified Suppliers will be returned.

If reserved_by is specified, only devices reserved by the specified Consumers will be returned.

list-reserved

adborc consumer list-reserved

Get a list of reserved devices in the network.

reserve

adborc consumer reserve <device-id>

Request to reserve a device from the MarketMaker. If the device is available, it will be reserved for the Consumer and tunnels (encrypted, if the device Supplier uses secure mode) will be setup for device communication. The device will be available for use on the Consumer system using adb on the specified port. If the device is not available, the request will fail.

See list-available to get a list of available devices.

release

adborc consumer release [device-id]

Release a device from the Consumer. The device will be added back to the network and will be available for use by other Consumers.

If no device-id is specified, all reserved devices will be released.

scrcpy

adborc consumer scrcpy <device-id> [-m/--max-size <size>] [-b/--bit-rate <bit-rate>] [--max-fps <fps>]

Start device screen mirroring using scrcpy for a device.

set-scrcpy-args

adborc consumer set-scrcpy-args [-m/--max-size <size>] [-b/--bit-rate <bit-rate>] [--max-fps <fps>]

Set the default arguments to be used when starting scrcpy for a device.

max-size: Limit both the width and height of the video to value. The other dimension is computed so that the device aspect-ratio is preserved. Default: 1920.

bit-rate: Encode the video at the gitven bit-rate, expressed in bits/s. Default: 2000000.

max-fps: Limit the frame rate of screen capture (officially supported since Android 10, but may work on earlier versions). Default: 30.

set-default

adborc consumer set-default <device-id>

Set a device as the default device. The default device will be available for use on the Consumer system using adb on the default port 5037 and extra port arguments are not required to access the device over adb.