package idb

Get desktop application:
View/edit binary Protocol Buffers messages

The idb companion service definition.

• rpc accessibility_info (AccessibilityInfoRequest, AccessibilityInfoResponse)

  idb.proto:27

  Interaction

  message AccessibilityInfoRequest

  idb.proto:237

  • optional Point point = 2

  • AccessibilityInfoRequest.Format format = 3

  message AccessibilityInfoResponse

  idb.proto:246

  • string json = 1

• rpc add_media (stream AddMediaRequest, AddMediaResponse)

  idb.proto:53

  Video/Audio

  message AddMediaRequest

  idb.proto:503

  • optional Payload payload = 1

  message AddMediaResponse

  idb.proto:507

  (message has no fields)

• rpc approve (ApproveRequest, ApproveResponse)

  idb.proto:38

  Settings

  message ApproveRequest

  idb.proto:250

  • string bundle_id = 1

  • repeated ApproveRequest.Permission permissions = 2

  • string scheme = 3

  message ApproveResponse

  idb.proto:265

  (message has no fields)

• rpc clear_keychain (ClearKeychainRequest, ClearKeychainResponse)

  idb.proto:40

  message ClearKeychainRequest

  idb.proto:284

  (message has no fields)

  message ClearKeychainResponse

  idb.proto:286

  (message has no fields)

• rpc connect (ConnectRequest, ConnectResponse)

  idb.proto:15

  Management

  message ConnectRequest

  idb.proto:391

  • map<string, string> metadata = 1

  • string local_file_path = 4

  message ConnectResponse

  idb.proto:396

  • optional CompanionInfo companion = 1

• rpc contacts_update (ContactsUpdateRequest, ContactsUpdateResponse)

  idb.proto:41

  message ContactsUpdateRequest

  idb.proto:317

  • optional Payload payload = 1

  message ContactsUpdateResponse

  idb.proto:321

  (message has no fields)

• rpc crash_delete (CrashLogQuery, CrashLogResponse)

  idb.proto:59

  Crash Operations

• rpc crash_list (CrashLogQuery, CrashLogResponse)

  idb.proto:60

• rpc crash_show (CrashShowRequest, CrashShowResponse)

  idb.proto:61

  message CrashShowRequest

  idb.proto:622

  • string name = 1

  message CrashShowResponse

  idb.proto:640

  • optional CrashLogInfo info = 1

  • string contents = 2

• rpc dap (stream DapRequest, stream DapResponse)

  idb.proto:18

  message DapRequest

  idb.proto:891

  • oneof control

    • DapRequest.Start start = 1

    • DapRequest.Pipe pipe = 2

    • DapRequest.Stop stop = 3

  message DapResponse

  idb.proto:906

  • oneof event

    • DapResponse.Event started = 1

    • DapResponse.Pipe stdout = 2

    • DapResponse.Event stopped = 3

• rpc debugserver (stream DebugServerRequest, stream DebugServerResponse)

  idb.proto:16

  message DebugServerRequest

  idb.proto:590

  • oneof control

    • DebugServerRequest.Start start = 1

    • DebugServerRequest.Stop stop = 2

    • DebugServerRequest.Status status = 3

    • DebugServerRequest.Pipe pipe = 4

  message DebugServerResponse

  idb.proto:607

  • oneof control

    • DebugServerResponse.Status status = 1

    • DebugServerResponse.Pipe pipe = 2

• rpc describe (TargetDescriptionRequest, TargetDescriptionResponse)

  idb.proto:19

  message TargetDescriptionRequest

  idb.proto:323

  • bool fetch_diagnostics = 1

  message TargetDescriptionResponse

  idb.proto:327

  • optional TargetDescription target_description = 1

  • optional CompanionInfo companion = 2

• rpc focus (FocusRequest, FocusResponse)

  idb.proto:29

  message FocusRequest

  idb.proto:228

  (message has no fields)

  message FocusResponse

  idb.proto:230

  (message has no fields)

• rpc get_setting (GetSettingRequest, GetSettingResponse)

  idb.proto:43

  message GetSettingRequest

  idb.proto:145

  • Setting setting = 1

  • string name = 2

    iff setting == ANY

  • string domain = 3

    assumed "Apple Global Domain" if empty

  message GetSettingResponse

  idb.proto:151

  • string value = 1

• rpc hid (stream HIDEvent, HIDResponse)

  idb.proto:30

  message HIDEvent

  idb.proto:332

  • oneof event

    • HIDEvent.HIDPress press = 1

    • HIDEvent.HIDSwipe swipe = 2

    • HIDEvent.HIDDelay delay = 3

  message HIDResponse

  idb.proto:389

  (message has no fields)

• rpc install (stream InstallRequest, stream InstallResponse)

  idb.proto:20

  message InstallRequest

  idb.proto:186

  • oneof value

    • InstallRequest.Destination destination = 1

    • Payload payload = 2

    • string name_hint = 3

    • bool make_debuggable = 4

    • string bundle_id = 5

      (2022-03-02) REMOVE, For back compatibility only.

    • InstallRequest.LinkDsymToBundle link_dsym_to_bundle = 6

      Link dSYM to app bundle_id

    • bool override_modification_time = 7

    • bool skip_signing_bundles = 8

  message InstallResponse

  idb.proto:215

  • string name = 1

  • string uuid = 2

  • double progress = 3

• rpc instruments_run (stream InstrumentsRunRequest, stream InstrumentsRunResponse)

  idb.proto:21

  message InstrumentsRunRequest

  idb.proto:509

  • oneof control

    • InstrumentsRunRequest.Start start = 1

    • InstrumentsRunRequest.Stop stop = 2

  message InstrumentsRunResponse

  idb.proto:533

  • oneof output

    • bytes log_output = 1

    • Payload payload = 2

    • InstrumentsRunResponse.State state = 3

• rpc launch (stream LaunchRequest, stream LaunchResponse)

  idb.proto:48

  App

  message LaunchRequest

  idb.proto:482

  • oneof control

    • LaunchRequest.Start start = 1

    • LaunchRequest.Stop stop = 2

  message LaunchResponse

  idb.proto:498

  • optional ProcessOutput output = 3

  • optional DebuggerInfo debugger = 4

• rpc list_apps (ListAppsRequest, ListAppsResponse)

  idb.proto:49

  message ListAppsRequest

  idb.proto:163

  • bool suppress_process_state = 1

  message ListAppsResponse

  idb.proto:167

  • repeated InstalledAppInfo apps = 1

• rpc list_settings (ListSettingRequest, ListSettingResponse)

  idb.proto:45

  message ListSettingRequest

  idb.proto:155

  • Setting setting = 1

  message ListSettingResponse

  idb.proto:159

  • repeated string values = 1

• rpc log (LogRequest, stream LogResponse)

  idb.proto:23

  message LogRequest

  idb.proto:420

  • repeated string arguments = 1

  • LogRequest.Source source = 2

  message LogResponse

  idb.proto:429

  • bytes output = 1

• rpc ls (LsRequest, LsResponse)

  idb.proto:69

  File Operations

  message LsRequest

  idb.proto:811

  • string path = 2

  • optional FileContainer container = 3

  • repeated string paths = 4

  message LsResponse

  idb.proto:806

  • repeated FileInfo files = 1

  • repeated FileListing listings = 2

• rpc mkdir (MkdirRequest, MkdirResponse)

  idb.proto:70

  message MkdirRequest

  idb.proto:817

  • string path = 2

  • optional FileContainer container = 3

  message MkdirResponse

  idb.proto:822

  (message has no fields)

• rpc mv (MvRequest, MvResponse)

  idb.proto:71

  message MvRequest

  idb.proto:824

  • repeated string src_paths = 2

  • string dst_path = 3

  • optional FileContainer container = 4

  message MvResponse

  idb.proto:830

  (message has no fields)

• rpc open_url (OpenUrlRequest, OpenUrlRequest)

  idb.proto:31

  message OpenUrlRequest

  idb.proto:311

  • string url = 1

• rpc pull (PullRequest, stream PullResponse)

  idb.proto:73

  message PullRequest

  idb.proto:852

  • string src_path = 2

  • string dst_path = 3

  • optional FileContainer container = 4

  message PullResponse

  idb.proto:858

  • optional Payload payload = 1

• rpc push (stream PushRequest, PushResponse)

  idb.proto:74

  message PushRequest

  idb.proto:839

  • oneof value

    • Payload payload = 1

    • PushRequest.Inner inner = 2

  message PushResponse

  idb.proto:850

  (message has no fields)

• rpc record (stream RecordRequest, stream RecordResponse)

  idb.proto:54

  message RecordRequest

  idb.proto:433

  • oneof control

    • RecordRequest.Start start = 1

    • RecordRequest.Stop stop = 2

  message RecordResponse

  idb.proto:444

  • oneof output

    • bytes log_output = 1

    • Payload payload = 2

• rpc revoke (RevokeRequest, RevokeResponse)

  idb.proto:39

  message RevokeRequest

  idb.proto:267

  • string bundle_id = 1

  • repeated RevokeRequest.Permission permissions = 2

  • string scheme = 3

  message RevokeResponse

  idb.proto:282

  (message has no fields)

• rpc rm (RmRequest, RmResponse)

  idb.proto:72

  message RmRequest

  idb.proto:832

  • repeated string paths = 2

  • optional FileContainer container = 3

  message RmResponse

  idb.proto:837

  (message has no fields)

• rpc screenshot (ScreenshotRequest, ScreenshotResponse)

  idb.proto:55

  message ScreenshotRequest

  idb.proto:221

  (message has no fields)

  message ScreenshotResponse

  idb.proto:223

  • bytes image_data = 1

  • string image_format = 2

• rpc send_notification (SendNotificationRequest, SendNotificationResponse)

  idb.proto:33

  message SendNotificationRequest

  idb.proto:884

  • string bundle_id = 1

  • string json_payload = 2

  message SendNotificationResponse

  idb.proto:889

  (message has no fields)

• rpc set_location (SetLocationRequest, SetLocationResponse)

  idb.proto:32

  message SetLocationRequest

  idb.proto:288

  • optional Location location = 1

  message SetLocationResponse

  idb.proto:297

  (message has no fields)

• rpc setting (SettingRequest, SettingResponse)

  idb.proto:42

  message SettingRequest

  idb.proto:111

  • oneof setting

    • SettingRequest.HardwareKeyboard hardwareKeyboard = 1

    • SettingRequest.StringSetting stringSetting = 2

  message SettingResponse

  idb.proto:143

  (message has no fields)

• rpc simulate_memory_warning (SimulateMemoryWarningRequest, SimulateMemoryWarningResponse)

  idb.proto:35

  message SimulateMemoryWarningRequest

  idb.proto:921

  (message has no fields)

  message SimulateMemoryWarningResponse

  idb.proto:923

  (message has no fields)

• rpc tail (stream TailRequest, stream TailResponse)

  idb.proto:75

  message TailRequest

  idb.proto:862

  • oneof control

    • TailRequest.Start start = 1

    • TailRequest.Stop stop = 2

  message TailResponse

  idb.proto:874

  • bytes data = 1

• rpc terminate (TerminateRequest, TerminateResponse)

  idb.proto:50

  message TerminateRequest

  idb.proto:305

  • string bundle_id = 1

  message TerminateResponse

  idb.proto:309

  (message has no fields)

• rpc uninstall (UninstallRequest, UninstallResponse)

  idb.proto:51

  message UninstallRequest

  idb.proto:299

  • string bundle_id = 1

  message UninstallResponse

  idb.proto:303

  (message has no fields)

• rpc video_stream (stream VideoStreamRequest, stream VideoStreamResponse)

  idb.proto:56

  message VideoStreamRequest

  idb.proto:451

  • oneof control

    • VideoStreamRequest.Start start = 1

    • VideoStreamRequest.Stop stop = 2

  message VideoStreamResponse

  idb.proto:475

  • oneof output

    • bytes log_output = 1

    • Payload payload = 2

• rpc xctest_list_bundles (XctestListBundlesRequest, XctestListBundlesResponse)

  idb.proto:63

  xctest operations

  message XctestListBundlesRequest

  idb.proto:654

  (message has no fields)

  message XctestListBundlesResponse

  idb.proto:656

  • repeated XctestListBundlesResponse.Bundles bundles = 1

• rpc xctest_list_tests (XctestListTestsRequest, XctestListTestsResponse)

  idb.proto:65

  message XctestListTestsRequest

  idb.proto:665

  • string bundle_name = 1

  • string app_path = 2

  message XctestListTestsResponse

  idb.proto:670

  • repeated string names = 1

• rpc xctest_run (XctestRunRequest, stream XctestRunResponse)

  idb.proto:67

  message XctestRunRequest

  idb.proto:674

  • optional XctestRunRequest.Mode mode = 1

  • string test_bundle_id = 2

  • repeated string tests_to_run = 3

  • repeated string tests_to_skip = 4

  • repeated string arguments = 5

  • map<string, string> environment = 6

  • uint64 timeout = 7

  • bool report_activities = 8

  • bool collect_coverage = 9

  • bool report_attachments = 10

  • bool collect_logs = 11

  • bool wait_for_debugger = 12

  • optional XctestRunRequest.CodeCoverage code_coverage = 13

  • bool collect_result_bundle = 14

  message XctestRunResponse

  idb.proto:715

  • XctestRunResponse.Status status = 1

  • repeated XctestRunResponse.TestRunInfo results = 2

  • repeated string log_output = 3

  • optional Payload result_bundle = 4

  • string coverage_json = 5

  • optional Payload log_directory = 6

  • optional DebuggerInfo debugger = 7

  • optional Payload code_coverage_data = 8

• rpc xctrace_record (stream XctraceRecordRequest, stream XctraceRecordResponse)

  idb.proto:24

  message XctraceRecordRequest

  idb.proto:546

  • oneof control

    • XctraceRecordRequest.Start start = 1

    • XctraceRecordRequest.Stop stop = 2

  message XctraceRecordResponse

  idb.proto:577

  • oneof output

    • bytes log = 1

    • Payload payload = 2

    • XctraceRecordResponse.State state = 3

Used in: AccessibilityInfoRequest

• LEGACY = 0

• NESTED = 1

Used in: ApproveRequest

• PHOTOS = 0

• CAMERA = 1

• CONTACTS = 2

• URL = 3

• LOCATION = 4

• NOTIFICATION = 5

• MICROPHONE = 6

Used in: ConnectResponse, TargetDescriptionResponse

• string udid = 1

• bool is_local = 4

• bytes metadata = 6

Used in: CrashLogResponse, CrashShowResponse

• string name = 1

• string bundle_id = 2

• string process_name = 3

• string parent_process_name = 4

• uint64 process_identifier = 5

• uint64 parent_process_identifier = 6

• uint64 timestamp = 7

Used as request type in: CompanionService.crash_delete, CompanionService.crash_list

• uint64 since = 1

• uint64 before = 2

• string bundle_id = 3

• string name = 4

Used as response type in: CompanionService.crash_delete, CompanionService.crash_list

• repeated CrashLogInfo list = 1

Used in: DapRequest

• bytes data = 1

Used in: DapRequest

• string debugger_pkg_id = 1

Used in: DapRequest

(message has no fields)

Used in: DapResponse

• string desc = 1

Used in: DapResponse

• bytes data = 1

Used in: DebugServerRequest

• bytes data = 1

Used in: DebugServerRequest

• string bundle_id = 1

Used in: DebugServerRequest

(message has no fields)

Used in: DebugServerRequest

(message has no fields)

Used in: DebugServerResponse

• bytes data = 1

Used in: DebugServerResponse

• repeated string lldb_bootstrap_commands = 1

Used in: LaunchResponse, XctestRunResponse

• uint64 pid = 1

• string host = 2

• uint64 port = 3

Used in: LsRequest, MkdirRequest, MvRequest, PullRequest, PushRequest.Inner, RmRequest, TailRequest.Start

• FileContainer.Kind kind = 1

• string bundle_id = 2

Used in: FileContainer

• NONE = 0

• APPLICATION = 1

• ROOT = 2

• MEDIA = 3

• CRASHES = 4

• PROVISIONING_PROFILES = 5

• MDM_PROFILES = 6

• SPRINGBOARD_ICONS = 7

• WALLPAPER = 8

• DISK_IMAGES = 9

• GROUP_CONTAINER = 10

• APPLICATION_CONTAINER = 11

• AUXILLARY = 12

• XCTEST = 13

• DYLIB = 14

• DSYM = 15

• FRAMEWORK = 16

• SYMBOLS = 17

Used in: FileListing, LsResponse

• string path = 1

Used in: LsResponse

• optional FileInfo parent = 1

• repeated FileInfo files = 2

Used in: HIDPressAction

• HIDButtonType button = 1

Used in: HIDButton

• APPLE_PAY = 0

• HOME = 1

• LOCK = 2

• SIDE_BUTTON = 3

• SIRI = 4

Used in: HIDEvent

• double duration = 1

Used in: HIDPress

• DOWN = 0

• UP = 1

Used in: HIDPressAction

• uint64 keycode = 1

Used in: HIDEvent

• optional HIDPressAction action = 1

• HIDDirection direction = 2

Used in: HIDPress

• oneof action

  • HIDTouch touch = 1

  • HIDButton button = 2

  • HIDKey key = 3

Used in: HIDEvent

• optional Point start = 1

• optional Point end = 2

• double delta = 5

• double duration = 6

Used in: HIDPressAction

• optional Point point = 1

Used in: InstallRequest

• APP = 0

• XCTEST = 1

• DYLIB = 2

• DSYM = 3

• FRAMEWORK = 4

Used in: InstallRequest

• LinkDsymToBundle.BundleType bundle_type = 1

• string bundle_id = 2

Used in: LinkDsymToBundle

• APP = 0

• XCTEST = 1

Used in: ListAppsResponse

• string bundle_id = 1

• string name = 2

• repeated string architectures = 3

• string install_type = 4

• InstalledAppInfo.AppProcessState process_state = 5

• bool debuggable = 6

• uint64 process_identifier = 7

Used in: InstalledAppInfo

• UNKNOWN = 0

• NOT_RUNNING = 1

• RUNNING = 2

Used in: Start

• double terminate_timeout = 1

• double launch_retry_timeout = 2

• double launch_error_timeout = 3

• double operation_duration = 4

Used in: InstrumentsRunRequest

• string template_name = 2

• string app_bundle_id = 3

• map<string, string> environment = 4

• repeated string arguments = 5

• optional InstrumentsTimings timings = 6

• repeated string tool_arguments = 7

Used in: InstrumentsRunRequest

• repeated string post_process_arguments = 1

Used in: InstrumentsRunResponse

• UNKNOWN = 0

• RUNNING_INSTRUMENTS = 1

• POST_PROCESSING = 2

Used in: LaunchRequest

• string bundle_id = 1

• map<string, string> env = 2

• repeated string app_args = 3

• bool foreground_if_running = 4

• bool wait_for = 5

• bool wait_for_debugger = 6

Used in: LaunchRequest

(message has no fields)

Used in: SetLocationRequest

• double latitude = 1

• double longitude = 2

Used in: LogRequest

• TARGET = 0

• COMPANION = 1

(message has no fields)

Used in: AddMediaRequest, ContactsUpdateRequest, InstallRequest, InstrumentsRunResponse, PullResponse, PushRequest, RecordResponse, VideoStreamResponse, XctestRunResponse, XctraceRecordResponse

• oneof source

  • string file_path = 1

  • bytes data = 2

  • string url = 3

  • Payload.Compression compression = 4

Used in: Payload

• GZIP = 0

• ZSTD = 1

Used in: AccessibilityInfoRequest, HIDEvent.HIDSwipe, HIDEvent.HIDTouch

• double x = 1

• double y = 2

Used in: LaunchResponse

• ProcessOutput.Interface interface = 1

• bytes data = 2

Used in: ProcessOutput

• STDOUT = 0

• STDERR = 1

Used in: PushRequest

• string dst_path = 2

• optional FileContainer container = 3

Used in: RecordRequest

• string file_path = 1

Used in: RecordRequest

(message has no fields)

Used in: RevokeRequest

• PHOTOS = 0

• CAMERA = 1

• CONTACTS = 2

• URL = 3

• LOCATION = 4

• NOTIFICATION = 5

• MICROPHONE = 6

Used in: TargetDescription

• uint64 width = 1

• uint64 height = 2

• double density = 3

• uint64 width_points = 4

• uint64 height_points = 5

Used in: GetSettingRequest, ListSettingRequest, SettingRequest.StringSetting

• LOCALE = 0

• ANY = 1

  any kind of app or global setting

Used in: SettingRequest

• bool enabled = 1

Used in: SettingRequest

• Setting setting = 1

• string value = 2

• string name = 3

  iff setting == ANY

• string domain = 4

  assumed "Apple Global Domain" if empty

• string value_type = 5

  Currently supported value_types and corresponding values are: string <string_value> data <hex_digits> int[eger] <integer_value> float <floating-point_value> bool[ean] (true | false | yes | no) date <date_rep> array <value1> <value2> ... array-add <value1> <value2> ... dict <key1> <value1> <key2> <value2> ... dict-add <key1> <value1> ... Check defaults set help for more details.

Used in: TailRequest

• optional FileContainer container = 1

• string path = 2

Used in: TailRequest

(message has no fields)

Used in: TargetDescriptionResponse

• string udid = 1

• string name = 2

• optional ScreenDimensions screen_dimensions = 3

• string state = 4

• string target_type = 5

• string os_version = 6

• string architecture = 7

• bytes extended = 9

• bytes diagnostics = 10

Used in: Start

• H264 = 0

• RBGA = 1

• MJPEG = 2

• MINICAP = 3

• I420 = 4

Used in: VideoStreamRequest

• string file_path = 1

• uint64 fps = 2

• Format format = 3

• double compression_quality = 4

• double scale_factor = 5

• double avg_bitrate = 6

• double key_frame_rate = 7

Used in: VideoStreamRequest

(message has no fields)

Used in: XctestListBundlesResponse

• string name = 1

• string bundle_id = 2

• repeated string architectures = 3

Used in: Mode

• string app_bundle_id = 1

Used in: XctestRunRequest

• bool collect = 1

• CodeCoverage.Format format = 2

• bool enable_continuous_coverage_collection = 3

Used in: CodeCoverage

• EXPORTED = 0

• RAW = 1

Used in: Mode

(message has no fields)

Used in: XctestRunRequest

• oneof mode

  • Logic logic = 1

  • Application application = 2

  • UI ui = 3

Used in: Mode

• string app_bundle_id = 1

• string test_host_app_bundle_id = 2

Used in: XctestRunResponse

• RUNNING = 0

• TERMINATED_NORMALLY = 1

• TERMINATED_ABNORMALLY = 2

Used in: XctestRunResponse

• TestRunInfo.Status status = 1

• string bundle_name = 2

• string class_name = 3

• string method_name = 4

• double duration = 5

• optional TestRunInfo.TestRunFailureInfo failure_info = 6

• repeated string logs = 7

• repeated TestRunInfo.TestActivity activityLogs = 8

• repeated TestRunInfo.TestRunFailureInfo other_failures = 9

Used in: TestRunInfo

• PASSED = 0

• FAILED = 1

• CRASHED = 2

Used in: TestRunInfo

• string title = 1

• double duration = 2

• string uuid = 3

• string activity_type = 4

• double start = 5

• double finish = 6

• string name = 7

• repeated TestAttachment attachments = 8

• repeated TestActivity sub_activities = 9

Used in: TestActivity

• bytes payload = 1

• double timestamp = 2

• string name = 3

• string uniform_type_identifier = 4

• bytes user_info_json = 5

Used in: TestRunInfo

• string failure_message = 1

• string file = 2

• uint64 line = 3

Used in: Target

• string process_to_launch = 1

• repeated string launch_args = 2

• string target_stdin = 3

• string target_stdout = 4

• map<string, string> process_env = 5

Used in: XctraceRecordRequest

• string template_name = 1

• double time_limit = 2

• string package = 3

• optional Target target = 4

Used in: XctraceRecordRequest

• double timeout = 1

• repeated string args = 2

Used in: Start

• oneof target

  • bool all_processes = 1

  • string process_to_attach = 2

  • LauchProcess launch_process = 3

Used in: XctraceRecordResponse

• UNKNOWN = 0

• RUNNING = 1

• PROCESSING = 2