Maintenance script: StudioZip wiki

2026-10-20T21:29:46Z

StudioZip wiki

New page

Studio ZIP adds a file system with the scheme <code>zipfs:</code> to VS Code. Files inside an archive can be opened through it like normal files: in editor tabs, with syntax highlighting, find and replace and the other editor features of VS Code.

== Opening a file in an editor tab ==
In the [[StudioZip:Archive Tab|Studio ZIP tab]], hover a file and click ''Open in editor''.
* A normal file opens in a regular VS Code editor tab.
* A nested archive, for example a <code>.jar</code> inside a <code>.war</code>, opens in its own Studio ZIP tab. From there you can go one level deeper in the same way.

Files from archives that cannot be written open as read-only editors.

== Mounting an archive ==
You can also add an archive to the workspace as an extra folder. It then appears in the Explorer like any other folder, and you can browse, open, create, rename and delete files there.

* '''From the Explorer:''' right-click the archive and choose ''Mount Archive as Workspace Folder''. This menu entry is shown for <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> and <code>.epub</code>.
* '''From the Command Palette:''' run <code>Studio ZIP: Mount Archive as Workspace Folder</code> and choose the archive in the file dialog. This works for the other formats too, including <code>.asar</code>.

The folder is added at the end of the workspace and named after the archive. VS Code cannot show the content under the archive file itself, so it is a separate folder at the bottom of the Explorer. If the archive is already mounted, you get the message <code><name> is already mounted.</code>

To remove it again, run <code>Studio ZIP: Unmount Archive Workspace Folder</code> and pick the archive from the list, or remove the folder from the workspace as usual. Unmounting does not change the archive.

Searching across files (<code>Ctrl+Shift+F</code>) does not cover mounted archives. Studio ZIP provides no search for its file system.

== Which archives can be written ==
Only the '''ZIP family''' can be written: <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.apk</code>, <code>.vsix</code>, <code>.epub</code> and every other format that is a ZIP inside. See [[StudioZip:Supported Formats|Supported Formats]].

All other formats are read-only. Changing a single file in a <code>.tar.xz</code> would mean compressing the whole archive again on every save. Their files open as read-only editors, and the summary line of the Studio ZIP tab shows <code>read-only</code>.

A nested archive can be written if every archive in the chain is a ZIP, for example a <code>.jar</code> inside a <code>.war</code>. Saving it writes the inner archive back into the outer one. A ZIP inside a <code>.tar.gz</code> is read-only, because the outer archive cannot be written.

An archive that contains encrypted files cannot be written at all. Saving fails with <code>Cannot write to an archive with encrypted entries (<name>).</code>

== What you can change ==
In a writable archive, the following work from an editor tab or a mounted folder:
* Save changes to a file (<code>Ctrl+S</code>).
* Create new files and folders. Missing parent folders are created with them.
* Delete files and folders. Deleting a folder removes everything in it.
* Rename and move files and folders inside the same archive.

Moving a file from one archive into another is not possible in one step. Studio ZIP refuses it with <code>Studio ZIP cannot move entries between archives.</code> Copy the file and delete the original instead.

== How saving works ==
ZIP has no way to change one file in place, so every save writes the whole archive again.
* The new archive is written to a temporary file next to the original (<code><archive>.studio-zip-<random>.tmp</code>). Only when it is complete does it replace the original. If VS Code crashes while writing, the original stays as it was.
* The file permissions of the archive itself are kept.
* Files you did not change are copied over one at a time with their compression method, modification time and Unix permissions, including the executable bit. A stored (uncompressed) file stays stored. This matters for <code>.epub</code>, where the <code>mimetype</code> file must not be compressed.
* The order of the files is kept. New files are added at the end.
* Files you changed or added are compressed and get the current time.
* Saves to the same archive run one after another, so two quick saves cannot overwrite each other.

Large archives are written in a stream, so saving a file in an archive of several gigabytes does not load the whole archive into memory. Saving still takes longer the larger the archive is.

{{StudioZip Nav}}

StudioZip:Editing Archives - Revision history

Maintenance script: StudioZip wiki