System Config Tool: Command-Line Options

Overview

The System Config Tool supports various commands directly from a USB keyboard with pressing F12 (or Tilde) key. Currently, the command line supports the following.

Command Description
alias Add or delete alias for commands.
bg_enable Enable or disable background daemons.
cat Print file(s) to standard output.
cd Change current directory.
copy Copy title from source title path to target device.
country Display or set the country.
create_syssave Create initial save data of some system applications. This manipulation will take a few minutes.
date Show date/time.
delete_save Delete all save directories associated with a title.
delete_user_data Delete user data from NAND.
delete_ver_list Delete version list.
drc_update Update DRC firmware.
exit Exit System Config Tool.
export_save Export save data to SD card.
fast_rle Display or set the global fast relaunch option.
fillup Generates a large number of save directories and fills up NAND or external USB storage fully.
findusb Display or set the find USB option.
gamereg Display or set the game region.
get_sys_version Display system version information.
get_ticketlist Display list of tickets for a title.
get_tid Display current title ID.
get_titleinfo Display information about a title.
get_titlesize Display size of title in bytes.
help List commands.
history Display history of entered commands.
import_save Import save data from SD card.
install Install title.
language Display or set the language.
launch Launch title.
limit_mem Displays or sets the memory limit.
list Display list of titles.
load List, acquire, or release RPL command package.
ls List directory.
mode List, show current, or change mode.
mount Mount volume.
nup_skip_check Configure settings for NUP skip.
prodarea Displays or sets the product area.
pwd Print current directory.
restart Restart System Config Tool.
set_apd Enable or disable Auto Power-Down.
set_install_dev Set target device for title installation.
set_latest_ver Set latest version for title.
set_required_ver Set required version for title.
set_updater Set system updater.
set_ver_list_ver Set version list version.
sleep Sleep before continuing.
source Run a script.
status Display status of last command.
sys_mode Set system mode.
syslog Outputs previous system log.
uninstall Uninstall title.
update Install update package.
update_check Check all update packages.
update_launch Install updater and launch it.

Top

alias

Syntax:

alias -A [alias] [cmd]

alias -D [alias]

alias -E   
Option Description
-A Set alias
-D Delete alias
-E Delete all aliases

Description: Add or delete an alias associated to a full command line [cmd].

After being set, an alias may be used to execute the command line associated to it. An alias may not contain any '-' characters. To view currently set aliases, use alias.

bg_enable

Syntax:

bg_enable [0 | 1]

Description: Enable (1) or disable (0) background daemons. Passing no arguments will display the current state of the background daemons.

cat

Syntax:

cat [options] [FILES]
Option Description
-h, -? Show help.
-n Number lines.
-x Dump as hex.
-X Dump as hex and characters.
-v Use escape sequences for non-printable characters.
-E Verbose error output.
-w [positive integer] Set width of line.
-s [positive integer] Start at specified line.
-e [positive integer] End at specified line.

Description: Print file(s) to standard output with formatting supplied by options. Default behavior will display as text and non-printable characters will appear as ".".

Top

cd

Syntax:

cd [directory]

Description: Change current directory. Use ".." to move up a level.

copy

Syntax:

copy [path] [mlc | usb]

Description: Copies a title at [path] to MLC or USB. To set the USB device index, see set_install_dev.

country

Syntax: country [country ID]

Description: Sets the country. Otherwise, displays the current setting.

For a complete list of country IDs, see the Wii U country list spreadsheet.

create_syssave

Syntax: create_syssave

Description: Create initial save data of some system applications. This manipulation will take a few minutes.

date

Syntax:

date

Description: Displays current date in MM/DD/YYYY HH:MM:SS format.

delete_save

Syntax:

delete_save [TID]

Description: Delete all save directories associated with a given title ID [TID] (in hex).

delete_user_data

Syntax:

delete_user_data

Description: Deletes all user data and resets the console to the initial state. This includes save directories and preferences.

Top

delete_ver_list

Syntax:

delete_ver_list

Description: Deletes version information for all titles.

drc_update

Syntax:

drc_update [1 | 2]

Description: Updates the DRC firmware for the DRC attached to port DRC1 (1) or DRC2 (2).

exit

Syntax:

exit [0 - 255]

Description: Exits System Config Tool. The argument acts as the exit code. Zero is returned in the case of no argument.

export_save

Syntax:

export_save [titleId] [mlc | hfiomlc | usb]

Description: Exports specified title's [titleId] save data from target device [mlc | hfiomlc | usb] to SD card.

fast_rle

Syntax:

fast_rle [0 | 1]

Description: Enable (1) or disable (0) the fast relaunch setting for all applications using the same OS. Providing no arguments displays the current state. This setting requires a restart to take effect.

Top

fillup

Syntax:

fillup [mlc | usb] [rest size(byte)]

Description: Generates a large number of save directories and fills up MLC or USB. [rest size(byte)] specifies the size to be left open on the device when filling up.

findusb

Syntax:

findusb [0 | 1]

Description: Enable (1) or disable (0) the find USB setting. When no arguments are provided, the current value is displayed.

gamereg

Syntax:

gamereg [0 - 6]
Code Region
0 Japan
1 USA
2 Europe
3 Australia
4 China
5 Korea
6 Taiwan

Description: Sets the game region when a value is provided. Otherwise, displays the current setting.

get_sys_version

Syntax:

get_sys_version

Description: Displays system version information.

get_ticketlist

Syntax:

get_ticketlist [TID] [options]
Option Description
-v Verbose mode

Description: Display tickets for a given title ID [TID] (in hex).

get_tid

Syntax:

get_tid

Description: Display title ID for current title.

get_titleinfo

Syntax:

get_titleinfo [TID]

Description: Displays group ID, path, type, version, OS, and SDK for a given title ID [TID] (in hex).

get_titlesize

Syntax:

get_titlesize [path]

Description: Displays the size of the title at [path].

Top

help

Syntax:

help [string]

Description: Display a list of commands. If a string is provided, only displays commands starting with that substring.

history

Syntax:

history [options]
Option Description
-c Clear history list
-n [N] Show only the last [N] commands
-? Display help

Description: Displays list of commands entered into shell.

Top

import_save

Syntax:

import_save [titleId] [persistentId] [mlc/hfiomlc/usb] [filePath]

Description: Imports specified title's [titleId] save data from SD card to target device [mlc | hfiomlc | usb] as specified account's [persistentId] save data.

install

Syntax:

install [path]

Description: Install title at [path] to current install device. The path must be to an installable image (i.e. created with makecfdownloadimage.sh). To set the install device, see set_install_dev.

language

Syntax: language [0 - 11]

Code language
0 Japanese
1 English
2 French
3 German
4 Italian
5 Spanish
6 Chinese
7 Korean
8 Dutch
9 Portuguese
10 Russian
11 Taiwanese

Description: Sets the language. Otherwise, displays the current setting.

launch

Syntax:

launch [-pl] [TID]

launch [-pl] -a [path]

launch [-pl] [DEV] [alias]

launch -A [TID] [alias]

launch -D [alias]
Option Description
-a Launch title from specific path
-l Enable preloading
-p Enable patch
-A Set alias
-D Delete alias

Description: Launch title based on title ID [TID] (in hex) or from specific [path].

After being set, an alias may be used to launch a title instead of a path or title ID. Use the optional [DEV] parameter to launch from the specific device. An alias may not contain any '-' characters. To view more information about valid [DEV] parameters or currently set aliases, use launch -h.

Top

limit_mem

Syntax:

limit_mem [0 | 1]

Description: Restricts (1) or unrestricts (0) memory to simulate production console environment. If no argument is provided, the current setting is displayed. Any changes will take effect on the next restart.

list

Syntax:

list [0 - N] [/s]

Description: List titles. Optionally will list only the first N titles. Specify zero to get the number of titles. Use "/s" to get the title size.

load

Syntax:

load [options]
Option Description
-l Show loaded packages
-I Reload all packages.
-R Release all packages.
-r [PkgName] Unload [PkgName].
-v Verbose output.
-h, -? Display help.

Description: Manage functionality packages for System Config Tool. By default, System Config Tool loads all packages in init.scp.

ls

Syntax:

ls [options] [dir]
-l Lists permissions, group ID, owner ID, size, along with the name.
-R Recursive mode with a maximum depth of 32.
-h, -? Display help

Description: Lists information about files in [dir] (if specified) or current directory.

mode

Syntax:

mode -l

mode [options] [M]
Option Description
-l List all modes currently loaded with System Config Tool.
-e [N] Send status [N] to next mode [M].

Description: Switch to mode [M] in System Config Tool.

Top

mount

Syntax:

mount [options]

mount [source] [target]
Option Description
-d List current devices.
-h, -? Display help.

Description: Mounts a [source] device to a [target] logical path.

nup_skip_check

Syntax:

nup_skip_check enable [0 - 1]
Code Description
0 Disable
1 Enable

Description: Configures settings for NUP skip.

prodarea

Syntax:

prodarea [0 - 6]
Code Region
0 Japan
1 USA
2 Europe
3 Australia
4 China
5 Korea
6 Taiwan

Description: Sets the product area when a value is provided. Otherwise, displays the current setting.

pwd

Syntax:

pwd

Description: Displays current directory.

Top

restart

Syntax:

restart

Description: Restarts System Config Tool.

set_apd

Syntax:

set_apd [-apd | -dim | ][0 | 1]

Description: Enable (1) or disable (0) Auto Power-Down.

set_install_dev

Syntax:

set_install_dev mlc

set_install_dev usb [index]

Description: Set install device to MLC or USB. If USB, a device index may be specified.

set_latest_ver

Syntax:

set_latest_ver [TID] [ver]

Description: Sets the latest version for an application with title ID [TID] (in hex) to [ver] (in decimal).

Top

set_required_ver

Syntax:

set_required_ver [TID] [ver]

Description: Sets the required version for an application with title ID [TID] (in hex) to [ver] (in decimal).

set_updater

Syntax:

set_updater [TID]

Description: Set updater to title ID [TID] (in hex).

set_ver_list_ver

Syntax:

set_ver_list_ver [ver]

Description: Sets the version list's version to [ver] (in decimal).

sleep

Syntax:

sleep [N]

Description: Sleep for [N] seconds before continuing. [N] must be a positive integer greater than zero.

source

Syntax:

source [options] [path]
Option Description
-c Continue even if error occurs
-q Run quietly. Commands will not echo.
-p Allows script to modify working directory.
-h, -? Display help.

Description: Execute commands from a script file. Script files must be less than 64K in size. Scripts may source other scripts, but maximum depth is 16.

Top

status

Syntax:

status [options]
Option Description
-n Prints status as number
-e [integer] Passes only if status equals N
-p [string] Set pass message
-f [string] Set failure message
-h, -? Show help

Description: Display status of last command.

sys_mode

Syntax:

sys_mode [0 | 1]

Description: Sets the system mode to development (1) or production (0). No arguments will display the current mode. Any changes will take effect on the next restart.

syslog

Syntax:

syslog

Description: Output the previous system log.

uninstall

Syntax:

uninstall [path]

Description: Uninstall title at the specified application [path].

update

Syntax:

update [path]

Description: Update with a user update package specified at [path]. Use update_check to find paths to update packages.

update_check

Syntax:

update_check

Description: List update packages and check if updates are available.

update_launch

Syntax:

update_launch [path]

Description: Update with a system update package specified at [path]. Use update_check to find paths to update packages.

Top

Revision History

2014/11/15 Updated command list.
2013/05/08 Automated cleanup pass.


CONFIDENTIAL