File copy (xbcp.exe) - XBOX Game Development Documentation

Use this tool to copy one or more files to or from a remote console.

Column 1
xbcp source [target] [/A[:attributes] ] [/B] [/M] [/S[:levels] ] [/W] [/X[:address] [+accesskey] [/title] ]

Option	Description
source	The source files’ names or directory. Wildcard characters in the file name are supported. For details, see the Remarks section later in this topic.
target	The target file’s name or directory. When more than one file is copied, the target must be a directory. If the target directory doesn’t exist, it’s created. For details, see the Remarks section later in this topic.
/A[:attributes]	Copies only files with the specified attributes. If no attributes are specified, it copies all non-system files that aren’t hidden. • H Hidden files • R Read-only files • S System files • A Files that are ready for archiving • - Negation prefix; copies files that don’t have the specified flag
/B	Uses bare format; only file names are displayed.
/M	Prints a summary of the transfer performance metrics after all files have been transferred.
/S[:levels]	Copies files that are in a specified directory and all its subdirectories. levels is an optional integer that specifies the subdirectory recursion depth. For example, xbcp /S:1 processes only the specified directory and the subdirectories one level below it. If /S is specified but levels isn’t, all subdirectories are included.
/W	Copies files by using FILE_SHARE_WRITE semantics.
/X[:address] [+accesskey] [/title]	• Use this option to specify the host name or address (shown as Tools IP on the console) of a targeted console without changing the default console. For details about setting a host name for a console, see Setting a host name for the console IP address. • If you don’t use this option, the default console (previously set by Connect (xbconnect.exe)) is used. • Use the accesskey string to provide console access only to those people who have the access key. • Set the access key by using the command xbconfig accesskey=your-key, and then restart your console to make the access key effective. • To access a console that’s configured with an access key, include a plus sign (+) and the access key after the IP address or host name of the console. • If an access key is provided when the default console is set by xbconnect, the access key is stored as part of the default console’s address. • For more information about access keys, see xbconfig accesskey. • If you append /title to /X, after the address or by itself, the partition mapping that’s seen by a running exclusive app is used. For example, specifying /X/title xd: would provide access to the default console’s scratch-drive partition that’s visible to the running exclusive apps.
/LC	Specify the locale code. Used to overide the default locale code

Remarks

Targeting files and directories in the shared scratch-drive partition

The drive-D partition is now accessible as a shared scratch space in the system and from within the Game OS. To copy titles in this shared drive, use xbcp (with or without the /x/title address) to access the drive partitions and files that are being used by the exclusive resource app. For example, to copy all files from the console scratch drive, use one of the following commands.

xbcp /X:/Title /S xd:\ c:\

xbcp /S xd:\ c:\

If a legacy XBOX One Software Development Kit title is running, drive D is the legacy TitleScratch drive, which isn’t the same as drive D in the system but is accessible in the system via the TitleScratch network share when the title isn’t running.

Targeting files and directories in an app container

While an exclusive app is running, the app container is read-only and mapped to drive G in the exclusive partition. For example, to copy data.bin from the app container while an exclusive app is running, use the following command.

xbcp /S /X:/title XG:\ c:\

Apps that are packaged at build time are read-only. Files and directories can be copied for these apps but can’t be added, deleted, or modified.

​Remarks

​Targeting files and directories in the shared scratch-drive partition

​Targeting files and directories in an app container

​See also

Remarks

Targeting files and directories in the shared scratch-drive partition

Targeting files and directories in an app container

See also