`remote` operations#

6 operations. Generated from assets/operations.json; all areas.

On this page (6)

Mac workspaces

List explicitly configured SSH Mac workspaces.

Annotations: read-only, idempotent, open world.

Takes no arguments.

tomaccoctl call remote.list

Connect Mac

Configure an SSH host alias and absolute directory; authentication stays in SSH.

Annotations: writes, idempotent, open world.

Argument	Type	Required
`name`	string	yes
`host`	string	yes
`directory`	string	yes

tomaccoctl call remote.configure '{"name":"<name>","host":"<host>","directory":"<directory>"}'

Check Mac

Check macOS, Xcode and available Simulator devices through SSH.

Annotations: read-only, idempotent, open world.

Argument	Type	Required	Default	Details
`name`	string	yes

tomaccoctl call remote.check '{"name":"<name>"}'

Transfer project to Mac

Sync project files without deleting remote files; exclude credentials and build caches.

Annotations: writes, idempotent, open world.

Argument	Type	Required	Default	Details
`name`	string	yes
`path`	string	yes		non-empty; Absolute local filesystem path

tomaccoctl call remote.sync '{"name":"<name>","path":"<path>"}'

Run on Mac

Run an argv array in the configured remote workspace, e.g. xcodebuild or xcrun simctl.

Annotations: destructive, not idempotent, open world.

Argument	Type	Required	Default	Details
`name`	string	yes
`argv`	array of string	yes		1 to 100 items
`timeout`	integer		`1800`	1 to 86400

tomaccoctl call remote.run '{"name":"<name>","argv":["<argv>"]}'

Download Mac artifact

Download a workspace-relative build artifact through SSH/rsync.

Annotations: writes, not idempotent, open world.

Argument	Type	Required	Details
`name`	string	yes
`remote_path`	string	yes
`path`	string	yes	non-empty; Absolute local filesystem path

tomaccoctl call remote.fetch '{"name":"<name>","remote_path":"<remote_path>","path":"<path>"}'

remote operations#