Inspect and retrieve files from your running app

Read and export files from approved iOS app directories to investigate logs, caches, and other local data.

FileSystem tools help you inspect the files behind a problem and retrieve them for closer analysis. Start with read-only access to approved directories; enable file changes only when a local debugging workflow needs them.

Install

Published pod: AnsightToolsFileSystem.

SwiftPM:

.product(name: "AnsightToolsFileSystem", package: "ansight-sdk")

CocoaPods:

pod 'AnsightToolsFileSystem'

Register the Suite

import AnsightCore
import AnsightToolsFileSystem

let fileSystem = AnsightFileSystemToolsOptions.createBuilder()
    .addRoot(alias: "exports", path: "/path/to/exports")
    .build()

try AnsightRuntime.shared.registerFileSystemTools(options: fileSystem)

Registration API

  • registerFileSystemTools(options:): registers the suite.
  • AnsightFileSystemToolsOptions.createBuilder(): creates a suite options builder.
  • addRoot(alias:path:): exposes an additional approved root.

Specific Concerns

  • All access is constrained to approved roots.
  • File contents are sensitive even when only read tools are enabled.
  • files.push_file, files.copy_file, and files.move_file use .write.
  • files.delete_file uses .critical and requires .fullAccess.
  • files.begin_binary_download streams bytes over the binary transfer channel.

Tool Matrix

NameIdPolicyDescription
List Directoryfiles.list_directoryReadLists files and folders inside approved roots.
Read Filefiles.read_fileReadReads a constrained file.
Get File Checksumfiles.get_file_checksumReadComputes file checksums without returning contents.
Download Filefiles.download_fileReadDownloads chunks through JSON fallback.
Begin Binary Downloadfiles.begin_binary_downloadReadStarts binary WebSocket download for a constrained file.
Push Filefiles.push_fileWriteWrites caller-provided content into an approved root.
Copy Filefiles.copy_fileWriteCopies a constrained file.
Move Filefiles.move_fileWriteMoves or renames a constrained file.
Delete Filefiles.delete_fileCriticalDeletes a constrained file.

Tool Details

Use read tools for directory listing, content inspection, checksums, and downloads. Use write tools for app-sandbox repair workflows. Use delete only when the workflow explicitly depends on removing files.