File Operations

File manipulation and archive operations for copying files and uploading files to FirmwareCI.

Archive

Upload files from the test environment or host to your FirmwareCI job report.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`archive`	Command name
`name`	`string`	Yes		Unique identifier for the test step (shown in reports, logs, and WebUI)
`transport`	`TransportObject`	No		Transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`ArchiveOptions`	Yes		Archive-specific parameters

Archive Options

Attribute	Type	Required	Default	Description
`path`	`string`	Yes		Path to the file to upload
`name`	`string`	No		Custom name for the uploaded file (defaults to original file name if not set)

Archive Example

cmd: archive
name: Upload OS release info
transport: *transport
options:
  timeout: 1m
parameters:
  path: "/etc/os-release"
  name: "os-infos.txt"

Copy

Copy files to the DUT.

Attribute	Type	Required	Default	Description
`cmd`	`const`	Yes	`copy`	Command Name
`name`	`string`	Yes		Name to uniquely identify the teststep. This name will show up in reports, logs and the WebUI
`transport`	`TransportObject`	No		Additional transport options
`options`	`OptionsObject`	No		Additional command options
`parameters`	`CopyOptions`	Yes		Options passed into the `copy` cmd

Copy Options

Attribute	Type	Required	Default	Description
`source`	`string`	Yes		Source Location of the file to copy to the DUT.
`destination`	`string`	Yes		Destination Location of the file to copy to the DUT
`recursive`	`bool`	No	`false`	Copy recursively
`variable`	`string`	No		Specifies the name of the variable in which to store the destination path.
`permissions`	`string`	No	`preserve`	File permissions for the copied file/directory. Can be octal mode (e.g., `0755`, `0644`) or `preserve` for source permissions.
`owner`	`string`	No		Owner of the copied file/directory. Can only be UID (e.g., `1000`).
`group`	`string`	No		Group of the copied file/directory. Can only be GID (e.g., `1000`).

Copy Example

cmd: copy
name: Copy some tooling to DUT
transport: *transport
parameters:
  source: "[[storage.my-tooling]]/tool"
  destination: /tmp/tool
  recursive: true
  variable: toolpath
  permissions: "0755"
  owner: 1000
  group: 1000