read
Options
string
required
Repository name.
string | undefined
Organization override.
string | undefined
Repository-relative path. Omit or pass an empty string for the repository root.
string | undefined
Change to read from. Defaults to the current change at the default bookmark tip.
number | undefined
Directory traversal depth from
0 to 10.Response
ContentFile
Regular file content.
ContentSymlink
Symbolic link content.
ContentDirectory
Directory listing.
ContentFile
'file'
Content variant discriminator.
string
Base name of the file.
string
Repository-relative path.
string
Git object SHA.
boolean | undefined
Whether this path is conflicted when known.
number
Size in bytes.
'base64'
Encoding used for
content.string
Base64-encoded file bytes.
'100644' | '100755'
POSIX file mode.
Record<string, string> | undefined
Extended attributes for this path. Values are base64-encoded.
ContentSymlink
'symlink'
Content variant discriminator.
string
Base name of the symlink.
string
Repository-relative path.
string
Git object SHA.
boolean | undefined
Whether this path is conflicted when known.
number
Size in bytes.
'base64'
Encoding used for
content.string
Base64-encoded symlink target bytes.
'120000'
POSIX symlink mode.
Record<string, string> | undefined
Extended attributes for this path. Values are base64-encoded.
ContentDirectory
'dir'
Content variant discriminator.
string
Base name of the directory.
string
Repository-relative path.
string
Git object SHA.
number
Number of direct children in this directory.
ContentDirectoryEntry[]
Directory entries returned for the requested depth.
Record<string, string> | undefined
Extended attributes attached to this directory. Values are base64-encoded.
ContentDirectoryEntry
'file' | 'symlink' | 'dir'
Entry variant discriminator.
string
Base name of the entry.
string
Repository-relative path.
string
Git object SHA.
number | undefined
Size in bytes for file and symlink entries.
'100644' | '100755' | '120000' | undefined
POSIX mode for file and symlink entries.

