How to extract xip archive using command line?

E

8

28

I searched around how to extract XIP archive using command line with no luck so I am leaving my own solution, as a bash function, here.

I found my inspiration here.

Escargot answered 4/11, 2016 at 3:4 Comment(2)

Possible duplicate of Extract .xip files into a specific folder – Doddering 21/10, 2018 at 8:28

Having asnwered both: I am in favor of removing this as a dupe as well. I have cleaned up the other question and believe it should suffice. – Doddering 14/7, 2021 at 4:36

E

8

function unxip()
{
    [ -z "$1" ] && echo "usage: unxip /path/to/archive.xip" && return

    # http://newosxbook.com/src.jl?tree=listings&file=pbzx.c
    PBZX="/usr/local/src/pbzx/pbzx" && [ ! -x "$PBZX" ] && echo "$PBZX not found." && return

    [ ! -f "$1" ] && echo "$1 not found." && return

    [ -f "Content" ] || [ -f "Metadata" ] && echo "Content or Metadata already exists." && return

    pkgutil --check-signature "$1" && xar -xf "$1" && "$PBZX" Content | sudo tar x --strip-components=1

    rm "Content" "Metadata"
}

We first check for xip file signature then extract its contents using xar. We then use Jonathan Levin pbzx to properly unpack pbzx chunks and pipe the output to tar, skipping . to avoid overwriting current working directory permissions.

This does the trick to unpack Xcode8.xip archives on OS X El Capitan.

Escargot answered 4/11, 2016 at 3:33 Comment(4)

This is undesirable from a CI point of view since it requires installing a third party app when native tools (/System/Library/CoreServices/Applications/Archive Utility.app/Contents/MacOS/Archive Utility) installed on the system already perform the work. – Albano 4/12, 2017 at 17:15

@Albano from a CI point of view: how can the Archive Utility be feasibly integrated into a shell script to achieve automation? Can it be scripted? Or did you think of double-clicking the XIP archive? – Shitty 22/6, 2018 at 16:37

@Shitty if you just do open -W archive.xip from terminal that will launch bomArchiveHelper and unpack the xip in the current directory and will block until the unarchive is complete. I use this to open Xcode.xip via a shell call in Jenkins all the time. The -W flag tells the shell to wait for the application invoked to exit before proceeding. – Albano 28/6, 2018 at 17:0

Upvoted, but see below for an easier solution: brew install thii/unxip/unxip also unxips correctly Xcode archives, unlike Apple tools. (but it needs compilation of the pbzx tool from source, which needs to also build a custom lib....) – Samale 12/5, 2020 at 10:33

D

40

You could try:

xip -x [path to .xip file]

Doddering answered 13/6, 2018 at 11:18 Comment(1)

This is the way. – Umbria 11/2, 2022 at 7:24

H

14

On macOS Mojave (not sure about other OS versions), navigate to the directory into which you’d like to expand the contents, then run xip --expand /path/to/xip.xip. For instance:

iMac:Applications jeff$ xip --expand /Users/jeff/Downloads/Xcode_11_Beta.xip

Higginson answered 16/6, 2019 at 21:39 Comment(2)

I've just checked that in macOS High Sierra (10.13.6) this command works as well, although not mentioned in 'man xip', curiously. I had some authentication issue which re-downloading the file from developer.apple.com cleared it. – Furred 1/3, 2020 at 18:33

I can confirm that xip --expand works in 10.12 Sierra & 10.11 El Capitan as well, even though it wasn't added to the man page until macOS 10.14. – Inexplicit 26/2, 2022 at 23:46

E

8

function unxip()
{
    [ -z "$1" ] && echo "usage: unxip /path/to/archive.xip" && return

    # http://newosxbook.com/src.jl?tree=listings&file=pbzx.c
    PBZX="/usr/local/src/pbzx/pbzx" && [ ! -x "$PBZX" ] && echo "$PBZX not found." && return

    [ ! -f "$1" ] && echo "$1 not found." && return

    [ -f "Content" ] || [ -f "Metadata" ] && echo "Content or Metadata already exists." && return

    pkgutil --check-signature "$1" && xar -xf "$1" && "$PBZX" Content | sudo tar x --strip-components=1

    rm "Content" "Metadata"
}

We first check for xip file signature then extract its contents using xar. We then use Jonathan Levin pbzx to properly unpack pbzx chunks and pipe the output to tar, skipping . to avoid overwriting current working directory permissions.

This does the trick to unpack Xcode8.xip archives on OS X El Capitan.

Escargot answered 4/11, 2016 at 3:33 Comment(4)

This is undesirable from a CI point of view since it requires installing a third party app when native tools (/System/Library/CoreServices/Applications/Archive Utility.app/Contents/MacOS/Archive Utility) installed on the system already perform the work. – Albano 4/12, 2017 at 17:15

@Albano from a CI point of view: how can the Archive Utility be feasibly integrated into a shell script to achieve automation? Can it be scripted? Or did you think of double-clicking the XIP archive? – Shitty 22/6, 2018 at 16:37

@Shitty if you just do open -W archive.xip from terminal that will launch bomArchiveHelper and unpack the xip in the current directory and will block until the unarchive is complete. I use this to open Xcode.xip via a shell call in Jenkins all the time. The -W flag tells the shell to wait for the application invoked to exit before proceeding. – Albano 28/6, 2018 at 17:0

Upvoted, but see below for an easier solution: brew install thii/unxip/unxip also unxips correctly Xcode archives, unlike Apple tools. (but it needs compilation of the pbzx tool from source, which needs to also build a custom lib....) – Samale 12/5, 2020 at 10:33

P

8

Use unxip. You can install it with Homebrew:

brew install thii/unxip/unxip

To extract a .xip file:

unxip path/to/.xip

Parma answered 5/8, 2018 at 7:49 Comment(3)

Unxiping XCode 10.1 was not working with Unarchiver... but this did the trick, thanks! – Samale 12/5, 2020 at 10:33

this save me countless hours of frustrations. thanks. I used this to extract Xcode_12.5.1.xip – Oat 29/6, 2021 at 10:51

@IeeCoder It's been stuck for me on Expanding items from “Xcode_12.5.1.xip”: 99% for quite a while now. shall I give up? (what's wrong with that xip? no tool to extract it...) – Wehner 17/11, 2021 at 14:33

A

6

open -W archive.xip will work better since it will then block until the archive has finished opening.

Albano answered 4/12, 2017 at 17:12 Comment(0)

P

0

On MacOS Monterey 12.7 the following worked for me:

Download the
Extract xip archive: xip --expand ~/Downloads/Xcode_14.3.1.xip
Ignore warning message xip: signing certificate was "Software Update" (validation not attempted)
Wait a very very long time for archive to extract with no feedback (I did it overnight)
Move expanded folder to /Applications: sudo mv Xcode.app /Applications
To run Xcode you must use full path to executable or lese you will get an error: /Applications/Xcode.app/Contents/MacOS/Xcode

Pekingese answered 4/10, 2023 at 15:50 Comment(0)

I

-1

In my case, i used unxip

brew install unxip

Then extract

unxip <Path-To-The-.xip-File>

Itis answered 30/4, 2023 at 3:33 Comment(1)

Please do not post duplicate answers. – Peeved 30/4, 2023 at 16:26

T

-3

You could just run:

open archive.xip

Tref answered 11/9, 2017 at 20:58 Comment(0)

Recommended topics

Hot tags