Maintenance script: StudioZip wiki

2026-10-20T21:29:46Z

StudioZip wiki

New page

== Commands ==
All commands are in the category ''Studio ZIP''. Open the Command Palette with <code>Ctrl+Shift+P</code> and type "Studio ZIP".

{| class="wikitable"
! Command !! ID !! What it does
|-
| <code>Studio ZIP: Mount Archive as Workspace Folder</code> || <code>studioZip.mountArchive</code> || Adds an archive to the workspace as an extra folder. From the Command Palette a file dialog asks for the archive. From the Explorer context menu it uses the file you right-clicked. See [[StudioZip:Editing Archives#Mounting an archive|Mounting an archive]].
|-
| <code>Studio ZIP: Unmount Archive Workspace Folder</code> || <code>studioZip.unmountArchive</code> || Shows a list of the mounted archives and removes the one you pick from the workspace. If nothing is mounted, it shows <code>No archives are mounted.</code>
|-
| <code>Studio ZIP: Open in Studio ZIP</code> || <code>studioZip.openArchiveEditor</code> || Opens an archive in the Studio ZIP tab. Without an argument a file dialog asks for the archive. This command is hidden from the Command Palette. You can still bind it to a key.
|}

=== File dialog ===
The file dialog of the commands above lists these types under ''Archives'': <code>zip</code>, <code>jar</code>, <code>war</code>, <code>ear</code>, <code>aar</code>, <code>apk</code>, <code>ipa</code>, <code>vsix</code>, <code>nupkg</code>, <code>whl</code>, <code>xpi</code>, <code>crx</code>, <code>epub</code>, <code>tar</code>, <code>tgz</code>, <code>taz</code>, <code>gz</code>, <code>bz2</code>, <code>tbz</code>, <code>tbz2</code>, <code>xz</code>, <code>txz</code>, <code>zst</code>, <code>tzst</code>, <code>br</code>, <code>7z</code>, <code>rar</code>, <code>deb</code>, <code>udeb</code>, <code>ar</code>, <code>a</code>, <code>rpm</code>, <code>cpio</code>, <code>iso</code>, <code>cab</code>, <code>asar</code>, <code>unitypackage</code>, <code>crate</code>, <code>gem</code>, <code>msix</code>, <code>appx</code>, <code>aab</code> and <code>love</code>.

== Menus ==
{| class="wikitable"
! Menu !! Entry !! Shown for
|-
| Explorer context menu || ''Mount Archive as Workspace Folder'' || <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.ear</code>, <code>.aar</code>, <code>.apk</code>, <code>.ipa</code>, <code>.vsix</code>, <code>.nupkg</code>, <code>.whl</code>, <code>.xpi</code>, <code>.crx</code>, <code>.epub</code>
|}

Other archive types can be mounted from the Command Palette.

== Keybindings ==
Studio ZIP adds no keybindings of its own. To add one, open ''File → Preferences → Keyboard Shortcuts'' and search for the command ID. For example, in <code>keybindings.json</code>:
<pre>
{ "key": "ctrl+alt+m", "command": "studioZip.mountArchive" }
</pre>

== Settings ==
Open ''File → Preferences → Settings'' and search for "Studio ZIP", or edit <code>settings.json</code>.

{| class="wikitable"
! Setting !! Type !! Default !! What it does
|-
| <code>studioZip.preview.maxFileSizeBytes</code> || number, 0 or more || <code>5242880</code> (5 MB) || Files larger than this (uncompressed) are not previewed automatically in the Studio ZIP tab. The pane shows a ''Show anyway'' button instead. <code>0</code> turns the limit off. See [[StudioZip:Preview#Large files|Large files]].
|-
| <code>studioZip.detection.useMagicBytes</code> || boolean || <code>true</code> || Detects the archive format from the first bytes of the file. If no signature matches, the file extension is used. With <code>false</code> only the file extension counts. See [[StudioZip:Supported Formats#Format detection|Format detection]].
|}

Both settings are read when they are needed. <code>studioZip.preview.maxFileSizeBytes</code> applies to the next file you select. <code>studioZip.detection.useMagicBytes</code> applies to archives opened after the change. An archive that is already open keeps its format until it is closed.

Example:
<pre>
{
"studioZip.preview.maxFileSizeBytes": 20971520,
"studioZip.detection.useMagicBytes": true
}
</pre>

== Editor ==
{| class="wikitable"
! View type !! Name !! Priority
|-
| <code>studioZip.archive</code> || Studio ZIP || default
|}

Studio ZIP is the default editor for all patterns listed on [[StudioZip:Supported Formats#Opens on click|Supported Formats]]. To open such a file with a different editor, right-click it and choose ''Open With…''. To change the default for a pattern, use the VS Code setting <code>workbench.editorAssociations</code>.

== File system ==
Studio ZIP registers the URI scheme <code>zipfs:</code>. Files opened with ''Open in editor'' and mounted archives use it. The extension is activated when VS Code first needs this scheme or the Studio ZIP editor.

{{StudioZip Nav}}

StudioZip:Commands and Settings - Revision history

Maintenance script: StudioZip wiki