NKit CLI Cheat Sheet

A collection of examples with required and optional parameters listed. Parameters can be specified in the config or via command line.

See the Usage page for full parameter documentation and the File Masks page for input path syntax.

---

Common Parameters

The following params apply across almost all tasks:

Name	Description
in	Input file, folder, archive, or mask. Bare CLI args (not -name value) are treated as input paths
out	Output directory. Defaults to the input file's path
tmp	Temp path. Files written here first, moved to out on completion
r	Recursive input search: y / n
arc	Search inside archives: y / n
dat	Dat file path/mask (supports archive masks)
keys	Key file path/mask/directory/archive
v	Verify: y, n, datLookup
outAsDatMatch	Rename output to matched dat entry: y / n
cfg	Override config file. Use n to disable config

See File Masks for input path examples.

---

NKit Task Examples

Convert Wii/GameCube to RVZ

Name	Required	Example	Description
task	✅	convert
in	✅	*.iso	Any supported GC/Wii format
convert	✅	rvz:zstd:19:128k:16	Format string: rvz:compression:level:blockSize:parallelism
out		path	Output directory
v		y	Verify output matches source

Format string options:

• rvz or rvz:zstd — Zstandard level 19 (default)
• rvz:zstd:19:128k:16 — Full specification
• rvz:lzma:9:128k:16 — LZMA compression
• rvz:none:128k:16 — No compression
• Level: 1–21 for Zstd, 1–9 for LZMA
• Block size: 32k / 64k / 128k (default) / 256k / 512k / 1m / 2m

nkit -task convert -in *.iso -convert rvz
nkit -task convert -in *.iso -convert rvz:zstd:19:128k:16 -v y
nkit -task convert -in file.ciso -convert rvz:lzma -cfg n
nkit -task convert -in *.wbf? -convert rvz -out converted
nkit -task convert -in * -convert rvz -dat wii.dat -outAsDatMatch y
rvzconvert *.iso                                    # bundled clone app

Convert WiiU to WUX

Name	Required	Example	Description
task	✅	convert
in	✅	*.wud	WUD or WUX
convert	✅	wux
keys	✅	WiiUKeys.zip	Key files

nkit -task convert -in *.wud -convert wux -keys WiiUKeys.zip
nkit -task convert -in *.wud -convert wux -keys WiiUKeys.zip -v y
wuxconvert *.wud                                    # bundled clone app

Convert WiiU to APP

nkit -task convert -in *.wud -convert app -keys WiiUKeys.zip
nkit -task convert -in *.wux -convert app -keys WiiUKeys.zip
nkit -task convert -in tmd* -convert app            # CDN to APP

Convert ISO9660 to CSO/ZSO

nkit -task convert -in *.iso -convert cso -cfg n
nkit -task convert -in *.iso -convert zso -cfg n
nkit -task convert -in *.cso -convert zso           # CSO to ZSO

Decrypt PS3

nkit -task convert -in *.iso -convert deciso -keys PS3Keys.zip
nkit -task convert -in *.iso -convert deciso -keys PS3Keys.zip -v y

Encrypt PS3

nkit -task expand -in *.dec.iso -keys PS3Keys.zip
nkit -task expand -in file.iso -keys PS3Keys.zip -out encrypted

Expand (any system)

nkit -task expand -in *.rvz                         # RVZ → ISO
nkit -task expand -in *.wux -keys WiiUKeys.zip      # WUX → WUD
nkit -task expand -in *.ciso -cfg n                 # CISO → ISO
rvzconvert *.rvz                                    # clone app expands compressed formats

ConvertSwap (bidirectional)

nkit -task convertSwap -in *.iso                    # uncompressed → convert
nkit -task convertSwap -in *.rvz                    # compressed → expand
rvzconvert *.iso *.rvz                              # clone app handles both directions

Scan

nkit -task scan -in *.iso -r y
nkit -task scan -in * -r y -arc y                   # recursive, including archives
nkit -task scan -in *.iso -scanOut scans/

Verify

nkit -task verify -in *.iso -dat wii.dat
nkit -task verify -in *.rvz -v datLookup -dat redump.dat
nkit -task verify -in *.iso                         # uses internal checksums

Extract Files

Name	Required	Example	Description
task	✅	extract
in	✅	*	Any supported format
extract	✅	mi:*	m=mask, r=regex, f=forensic, i=case-insensitive
keys		path	Required for encrypted images

nkit -task extract -in *.rvz -extract mi:*                           # all files
nkit -task extract -in *.rvz -extract mi:/DATA/sys/boot.bin          # specific file
nkit -task extract -in *.wbfs -extract mi:/DATA/*                    # game partition
nkit -task extract -in *.rvz -extract ri:/[^/]+/sys/                 # regex: all sys dirs
nkit -task extract -in *.iso -extract mi:*.bin|*.sys                 # multiple extensions
nkit -task extract -in *.wux -keys WiiUKeys.zip -extract ri:GM.*     # WiiU game partitions
nkit -task extract -in *.iso -keys PS3Keys.zip -extract ri:^(/PS3_GAME/PARAM\.SFO|/PS3_GAME/USRDIR/EBOOT\.BIN)$

See File Masks for full mask/regex documentation.

Fix Wii/GameCube

nkit -task fix -in *.wbfs -fixInfo fix_wii.yaml -fixFiles dir -dat wii.dat
nkit -task fix -in * -fixInfo $appPath$/fix_$system$.yaml -fixFiles dir -cfg n

Fix PS3 (IRD + Files → ISO)

nkit -task fix -in path/*.sfb -fixInfo fix/fix_ps3.yaml -fixFiles fix/ps3
nkit -task fix -in path/*.zip -arc y -fixInfo fix/fix_ps3.yaml -fixFiles fix/ps3
nkit -task fix -in * -r y -fixInfo $appPath$/fix/fix_$system$.yaml -fixFiles dir

FixExtract (create recovery files)

# GameCube / Wii — extract fix files
nkit -task fixExtract -in *.iso -fixInfo $appPath$/fix_$system$.yaml

# PS3 — create IRD
nkit -task fixExtract -in *.iso -fixInfo fix/fix_ps3.yaml -out fix/ps3

Dedupe (to NKDS DataStore)

nkit -task dedupe -in *.iso -r y
nkit -task dedupe -in * -r y -arc y -v y

Note: Dedupe creates the .nkds DataStore format. For full DataStore management, use the nkds CLI. See the NKDS Cheat Sheet for nkds command examples.