PHAR(1)

📦 version 8.3.36, in arch rolling

💅 phar(1) — the PHP Archive CLI, explained by your favorite unix girlie

okay so bestie, you know how a whole entire PHP app is like so many files? yeah. this tool is the glow-up that smooshes all of them into one single file. it's called a "phar" (PHP Archive) and it's literally made for easy distribution and installation. periodt. 🎀

this page lives in the User Commands section of the manual (section 1, iykyk), and the tool answers to both phar and phar.phar. slay.

✨ NAME ✨

phar, phar.phar — the PHAR (PHP archive) command line tool 🦋

🌸 SYNOPSIS 🌸

phar <command> [options] ...

💖 DESCRIPTION 💖

the PHAR file format is the whole vibe: it lets you put entire PHP applications into a single file called a "phar" (PHP Archive) so distribution and installation are easy-peasy. 🫶

with the phar command you can create, update or extract PHP archives. main character energy honestly.

here's the full command roster, no gatekeeping:

add compress delete extract help help-list info list meta-del meta-get meta-set pack sign stub-get stub-set tree version

🧚 add command

adds entries to a PHAR package. like dropping new fits into the closet. 👑

required arguments:

  • -f file — specifies the phar file to work on.
  • ... — any number of input files and directories. if -i is in use then ONLY files matching the given regular expression get packed. if -x is given then files matching that regular expression are NOT being packed. 🙈

optional arguments:

  • -a alias — provide an alias name for the phar file.
  • -c algo — compression algorithm (see COMPRESSION below, bestie).
  • -i regex — specifies a regular expression for input files.
  • -l level — number of preceding subdirectories to strip from file entries.
  • -x regex — regular expression for input files to exclude.

🍓 compress command

compresses or uncompresses all files, or just one selected entry.

required arguments:

  • -c algo — compression algorithm (see COMPRESSION).
  • -f file — specifies the phar file to work on.

optional arguments:

  • -e entry — name of entry to work on (must include the PHAR internal directory name if there is any).

💀 delete command

deletes an entry from a PHAR archive. bye boo 👋

required arguments:

  • -e entry — name of entry to work on (must include the PHAR internal directory name if any).
  • -f file — specifies the phar file to work on.

🌈 extract command

extracts a PHAR package into a directory. unpacking, but make it cute.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -i regex — specifies a regular expression for input files.
  • -x regex — regular expression for input files to exclude.
  • ... — directory to extract to (defaults to '.').

🎀 help command

shows this help, or help for a selected command.

optional arguments:

  • ... — optional command to retrieve help for.

👑 help-list command

lists available commands. that's it, that's the whole job.

🔥 info command

gets information about a PHAR package.

by using -k it's possible to return a single value. ngl, super handy.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -k index — subscription index to work on.

⭐ list command

lists the contents of a PHAR archive.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -i regex — specifies a regular expression for input files.
  • -x regex — regular expression for input files to exclude.

🦋 meta-del command

deletes meta information of a PHAR entry or a PHAR package.

if -k is given then the metadata is expected to be an array and the given index is the one being deleted.

if something was deleted the return value is 0; otherwise it's 1.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -e entry — name of entry to work on (must include the PHAR internal directory name if any).
  • -k index — subscription index to work on.

💜 meta-get command

gets meta information of a PHAR entry or a PHAR package in serialized form. if no output file is specified for meta data then stdout is being used.

you can also specify a particular index using -k. in that case the metadata is expected to be an array and the value of the given index is returned using echo rather than using serialize. if that index does not exist, or no meta data is present, then the return value is 1. 😭

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -e entry — name of entry to work on (must include the PHAR internal directory name if any).
  • -k index — subscription index to work on.

🌸 meta-set command

sets meta data of a PHAR entry or a PHAR package using serialized input. if no input file is specified for meta data then stdin is being used.

you can also specify a particular index using -k. in that case the metadata is expected to be an array and the value of the given index is being set. if the metadata is not present or is empty, a new array will be created. if the metadata is present and is a flat value, then the return value is 1. also, when using -k the input is taken directly rather than being serialized.

required arguments:

  • -f file — specifies the phar file to work on.
  • -m meta — meta data to store with entry (serialized php data).

optional arguments:

  • -e entry — name of entry to work on (must include the PHAR internal directory name if any).
  • -k index — subscription index to work on.

💅 pack command

packs files into a PHAR archive. this is the big one, bestie.

when using -s stub, then the stub file is being excluded from the list of input files/dirs. to create an archive that contains PEAR class PHP_Archive, point the -p argument to PHP/Archive.php.

required arguments:

  • -f file — specifies the phar file to work on.
  • ... — any number of input files and directories. if -i is in use then ONLY files matching the given regular expression are being packed. if -x is given then files matching that regular expression are NOT being packed.

optional arguments:

  • -a alias — provide an alias name for the phar file.
  • -b bang — hash-bang line to start the archive (e.g. #!/usr/bin/php). the hash mark itself #! and the newline character are optional.
  • -c algo — compression algorithm (see COMPRESSION).
  • -h hash — selects the hash algorithm (see HASH).
  • -i regex — specifies a regular expression for input files.
  • -l level — number of preceding subdirectories to strip from file entries.
  • -p loader — location of PHP_Archive class file (pear list-files PHP_Archive). you can use '0' or '1' to locate it automatically using the mentioned pear command. when using '0' the command does not error out when the class file cannot be located. this switch also adds some code around the stub so that class PHP_Archive gets registered as phar:// stream wrapper if necessary. and finally, this switch will add the file phar.inc from this package and load it to ensure class Phar is present. 🤯
  • -s stub — select the stub file.
  • -x regex — regular expression for input files to exclude.
  • -y key — private key for OpenSSL signing.

🔐 sign command

sets the signature hash algorithm.

required arguments:

  • -f file — specifies the phar file to work on.
  • -h hash — selects the hash algorithm (see HASH).

optional arguments:

  • -y key — private key for OpenSSL signing.

🎀 stub-get command

gets the stub of a PHAR file. if no output file is specified as stub then stdout is being used.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -s stub — select the stub file.

🧚 stub-set command

sets the stub of a PHAR file. if no input file is specified as stub then stdin is being used.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -b bang — hash-bang line to start the archive (e.g. #!/usr/bin/php). the hash mark itself #! and the newline character are optional.
  • -p loader — location of PHP_Archive class file (pear list-files PHP_Archive). you can use '0' or '1' to locate it automatically using the mentioned pear command. when using '0' the command does not error out when the class file cannot be located. this switch also adds some code around the stub so that class PHP_Archive gets registered as phar:// stream wrapper if necessary. and finally, this switch will add the file phar.inc from this package and load it to ensure class Phar is present.
  • -s stub — select the stub file.

🌳 tree command

gets a directory tree for a PHAR archive. aesthetic.

required arguments:

  • -f file — specifies the phar file to work on.

optional arguments:

  • -i regex — specifies a regular expression for input files.
  • -x regex — regular expression for input files to exclude.

🦋 version command

gets information about the PHAR environment and the tool version. the vibe check, basically.

💖 COMPRESSION 💖

the algorithms, bestie:

  • 0 — no compression
  • none — no compression
  • auto — automatically select compression algorithm
  • gz — GZip compression
  • gzip — GZip compression
  • bz2 — BZip2 compression
  • bzip2 — BZip2 compression

🔐 HASH 🔐

the hash algorithms:

  • md5 — MD5
  • sha1 — SHA1
  • sha256 — SHA256
  • sha512 — SHA512
  • openssl — OpenSSL using SHA-1
  • openssl_sha256 — OpenSSL using SHA-256
  • openssl_sha512 — OpenSSL using SHA-512

🌈 SEE ALSO 🌈

for a more or less complete description of PHAR, look here: http://php.net/phar 🫶

💀 BUGS 💀

you can view the list of known bugs, or report any new bug you found, at: https://github.com/php/php-src/issues

fr fr, if something's cursed, tell the maintainers — they actually want to know. 🐛

👑 AUTHORS 👑

The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski.

work for the PHP archive was done by Gregory Beaver, Marcus Boerger.

a list of active developers can be found here: http://www.php.net/credits.php

and last but not least, PHP was developed with the help of a huge amount of contributors all around the world. 🌍💜 that's genuinely so sweet.

⭐ VERSION INFORMATION ⭐

this manpage describes phar, version 8.3.36.

Copyright © The PHP Group

this source file is subject to version 3.01 of the PHP license, that is bundled with this package in the file LICENSE, and is available through the world-wide-web at the following url: https://www.php.net/license/3_01.txt

if you did not receive a copy of the PHP license and are unable to obtain it through the world-wide-web, please send a note to license@php.net so we can mail you a copy immediately.

and that's the whole page, bestie — brought to you by The PHP Group, dated 2024, under the manual slot PHAR(1). go forth and pack some archives 💖✨🎀

📦 where this page comes from