zip
Compress a file or folder to a zip
| zip | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @KrauseFx |
| Returns | The path to the output zip file |
4 Examples
zip
zip( path: "MyApp.app", output_path: "Latest.app.zip" )
zip( path: "MyApp.app", output_path: "Latest.app.zip", verbose: false )
zip( path: "MyApp.app", output_path: "Latest.app.zip", verbose: false, symlinks: true )
Parameters
| Key | Description | Default |
|---|---|---|
path |
Path to the directory or file to be zipped | |
output_path |
The name of the resulting zip file | |
verbose |
Enable verbose output of zipped file | true |
password |
Encrypt the contents of the zip archive using a password | |
symlinks |
Store symbolic links as such in the zip archive | false |
* = default value is dependent on the user's system
Documentation
To show the documentation in your terminal, run
pantograph action zip
CLI
It is recommended to add the above action into your Pantfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run zip
To pass parameters, make use of the : symbol, for example
pantograph run zip parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all pantograph actions you use to your Pantfile.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub