Command-line Reference

This page documents the command-line flags available in FPM. You can also see this content in your terminal by running fpm --help

General Options

• -C CHDIR

  • Alternate option spellings: --chdir

  • Change directory to here before searching for files

• -S PACKAGE_NAME_SUFFIX

  • Alternate option spellings: --package-name-suffix

  • a name suffix to append to package and dependencies.

• -a ARCHITECTURE

  • Alternate option spellings: --architecture

  • The architecture name. Usually matches ‘uname -m’. For automatic values, you can use ‘-a all’ or ‘-a native’. These two strings will be translated into the correct value for your platform and target package type.

• -d DEPENDENCY

  • Alternate option spellings: --depends

  • A dependency. This flag can be specified multiple times. Value is usually in the form of: -d ‘name’ or -d ‘name > version’

• -e

  • Alternate option spellings: --edit

  • Edit the package spec before building.

• -f

  • Alternate option spellings: --force

  • Force output even if it will overwrite an existing file

• -m MAINTAINER

  • Alternate option spellings: --maintainer

  • The maintainer of this package.

• -n NAME

  • Alternate option spellings: --name

  • The name to give to the package

• -p OUTPUT

  • Alternate option spellings: --package

  • The package file path to output.

• -s INPUT_TYPE

  • Alternate option spellings: --input-type

  • the package type to use as input (gem, rpm, python, etc)

• -t OUTPUT_TYPE

  • Alternate option spellings: --output-type

  • the type of package you want to create (deb, rpm, solaris, etc)

• -v VERSION

  • Alternate option spellings: --version

  • The version to give to the package

• -x EXCLUDE_PATTERN

  • Alternate option spellings: --exclude

  • Exclude paths matching pattern (shell wildcard globs valid here). If you have multiple file patterns to exclude, specify this flag multiple times.

• --after-install FILE

  • A script to be run after package installation

• --after-remove FILE

  • A script to be run after package removal

• --after-upgrade FILE

  • A script to be run after package upgrade. If not specified, –before-install, –after-install, –before-remove, and –after-remove will behave in a backwards-compatible manner (they will not be upgrade-case aware). Currently only supports deb, rpm and pacman packages.

• --before-install FILE

  • A script to be run before package installation

• --before-remove FILE

  • A script to be run before package removal

• --before-upgrade FILE

  • A script to be run before package upgrade. If not specified, –before-install, –after-install, –before-remove, and –after-remove will behave in a backwards-compatible manner (they will not be upgrade-case aware). Currently only supports deb, rpm and pacman packages.

• --category CATEGORY

  • (optional) category this package belongs to

• --config-files CONFIG_FILES

  • Mark a file in the package as being a config file. This uses ‘conffiles’ in debs and %config in rpm. If you have multiple files to mark as configuration files, specify this flag multiple times. If argument is directory all files inside it will be recursively marked as config files.

• --conflicts CONFLICTS

  • Other packages/versions this package conflicts with. This flag can be specified multiple times.

• --debug

  • Enable debug output

• --debug-workspace

  • Keep any file workspaces around for debugging. This will disable automatic cleanup of package staging and build paths. It will also print which directories are available.

• --description DESCRIPTION

  • Add a description for this package. You can include ‘n’ sequences to indicate newline breaks.

• --directories DIRECTORIES

  • Recursively mark a directory as being owned by the package. Use this flag multiple times if you have multiple directories and they are not under the same parent directory

• --epoch EPOCH

  • The epoch value for this package. RPM and Debian calls this ‘epoch’. FreeBSD calls this ‘PORTEPOCH’

• --exclude-file EXCLUDE_PATH

  • The path to a file containing a newline-sparated list of patterns to exclude from input.

• --fpm-options-file FPM_OPTIONS_FILE

  • A file that contains additional fpm options. Any fpm flag format is valid in this file. This can be useful on build servers where you want to use a common configuration or inject other parameters from a file instead of from a command-line flag..

• --inputs INPUTS_PATH

  • The path to a file containing a newline-separated list of files and dirs to use as input.

• --iteration ITERATION

  • The iteration to give to the package. RPM calls this the ‘release’. FreeBSD calls it ‘PORTREVISION’. Debian calls this ‘debian_revision’

• --license LICENSE

  • (optional) license name for this package

• --log LEVEL

  • Set the log level. Values: error, warn, info, debug.

• --no-auto-depends

  • Do not list any dependencies in this package automatically

• --no-depends

  • Do not list any dependencies in this package

• --post-install FILE

  • (DEPRECATED, use –after-install) A script to be run after package installation

• --post-uninstall FILE

  • (DEPRECATED, use –after-remove) A script to be run after package removal

• --pre-install FILE

  • (DEPRECATED, use –before-install) A script to be run before package installation

• --pre-uninstall FILE

  • (DEPRECATED, use –before-remove) A script to be run before package removal

• --prefix PREFIX

  • A path to prefix files with when building the target package. This may not be necessary for all input packages. For example, the ‘gem’ type will prefix with your gem directory automatically.

• --provides PROVIDES

  • What this package provides (usually a name). This flag can be specified multiple times.

• --replaces REPLACES

  • Other packages/versions this package replaces. Equivalent of rpm’s ‘Obsoletes’. This flag can be specified multiple times.

• --source-date-epoch-default SOURCE_DATE_EPOCH_DEFAULT

  • If no release date otherwise specified, use this value as timestamp on generated files to reduce nondeterminism. Reproducible build environments such as dpkg-dev and rpmbuild set this via envionment variable SOURCE_DATE_EPOCH variable to the integer unix timestamp to use in generated archives, and expect tools like fpm to use it as a hint to avoid nondeterministic output. This is a Unix timestamp, i.e. number of seconds since 1 Jan 1970 UTC. See https://reproducible-builds.org/specs/source-date-epoch

• --source-date-epoch-from-changelog

  • Use release date from changelog as timestamp on generated files to reduce nondeterminism. Experimental; only implemented for gem so far.

• --template-scripts

  • Allow scripts to be templated. This lets you use ERB to template your packaging scripts (for –after-install, etc). For example, you can do things like <%= name %> to get the package name. For more information, see the fpm wiki: https://github.com/jordansissel/fpm/wiki/Script-Templates

• --template-value KEY=VALUE

  • Make ‘key’ available in script templates, so <%= key %> given will be the provided value. Implies –template-scripts

• --url URI

  • Add a url for this package.

• --vendor VENDOR

  • (optional) vendor name for this package

• --verbose

  • Enable verbose output

• --workdir WORKDIR

  • The directory you want fpm to do its work in, where ‘work’ is any file copying, downloading, etc. Roughly any scratch space fpm needs to build your package.

apk

This package type has no additional options

cpan

• --cpan-cpanm-bin CPANM_EXECUTABLE

  • The path to the cpanm executable you wish to run.

• --[no-]cpan-cpanm-force

  • Pass the –force parameter to cpanm

• --cpan-mirror CPAN_MIRROR

  • The CPAN mirror to use instead of the default.

• --[no-]cpan-mirror-only

  • Only use the specified mirror for metadata.

• --cpan-package-name-prefix NAME_PREFIX

  • Name to prefix the package name with.

• --cpan-perl-bin PERL_EXECUTABLE

  • The path to the perl executable you wish to run.

• --cpan-perl-lib-path PERL_LIB_PATH

  • Path of target Perl Libraries

• --[no-]cpan-sandbox-non-core

  • Sandbox all non-core modules, even if they’re already installed

• --[no-]cpan-test

  • Run the tests before packaging?

• --[no-]cpan-verbose

  • Produce verbose output from cpanm?

deb

• --deb-activate EVENT

  • Package activates EVENT trigger

• --deb-activate-noawait EVENT

  • Package activates EVENT trigger

• --deb-after-purge FILE

  • A script to be run after package removal to purge remaining (config) files (a.k.a. postrm purge within apt-get purge)

• --[no-]deb-auto-config-files

  • Init script and default configuration files will be labeled as configuration files for Debian packages.

• --deb-build-depends DEPENDENCY

  • Add DEPENDENCY as a Build-Depends

• --deb-changelog FILEPATH

  • Add FILEPATH as debian changelog

• --deb-compression COMPRESSION

  • The compression type to use, must be one of gz, bzip2, xz, zst, none.

• --deb-compression-level [0-9]

  • Select a compression level. 0 is none or minimal. 9 is max compression.

• --deb-config SCRIPTPATH

  • Add SCRIPTPATH as debconf config file.

• --deb-custom-control FILEPATH

  • Custom version of the Debian control file.

• --deb-default FILEPATH

  • Add FILEPATH as /etc/default configuration

• --deb-dist DIST-TAG

  • Set the deb distribution.

• --deb-field 'FIELD: VALUE'

  • Add custom field to the control file

• --[no-]deb-generate-changes

  • Generate PACKAGENAME.changes file.

• --deb-group GROUP

  • The group owner of files in this package

• --[no-]deb-ignore-iteration-in-dependencies

  • For ‘=’ (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted

• --deb-init FILEPATH

  • Add FILEPATH as an init script

• --deb-installed-size KILOBYTES

  • The installed size, in kilobytes. If omitted, this will be calculated automatically

• --deb-interest EVENT

  • Package is interested in EVENT trigger

• --deb-interest-noawait EVENT

  • Package is interested in EVENT trigger without awaiting

• --[no-]deb-maintainerscripts-force-errorchecks

  • Activate errexit shell option according to lintian. https://lintian.debian.org/tags/maintainer-script-ignores-errors.html

• --deb-meta-file FILEPATH

  • Add FILEPATH to DEBIAN directory

• --[no-]deb-no-default-config-files

  • Do not add all files in /etc as configuration files by default for Debian packages.

• --deb-pre-depends DEPENDENCY

  • Add DEPENDENCY as a Pre-Depends

• --deb-priority PRIORITY

  • The debian package ‘priority’ value.

• --deb-recommends PACKAGE

  • Add PACKAGE to Recommends

• --deb-shlibs SHLIBS

  • Include control/shlibs content. This flag expects a string that is used as the contents of the shlibs file. See the following url for a description of this file and its format: http://www.debian.org/doc/debian-policy/ch-sharedlibs.html#s-shlibs

• --deb-suggests PACKAGE

  • Add PACKAGE to Suggests

• --deb-systemd FILEPATH

  • Add FILEPATH as a systemd script

• --[no-]deb-systemd-auto-start

  • Start service after install or upgrade

• --[no-]deb-systemd-enable

  • Enable service on install or upgrade

• --deb-systemd-path FILEPATH

  • Relative path to the systemd service directory

• --[no-]deb-systemd-restart-after-upgrade

  • Restart service after upgrade

• --deb-templates FILEPATH

  • Add FILEPATH as debconf templates file.

• --deb-upstart FILEPATH

  • Add FILEPATH as an upstart script

• --deb-upstream-changelog FILEPATH

  • Add FILEPATH as upstream changelog

• --[no-]deb-use-file-permissions

  • Use existing file permissions when defining ownership and modes

• --deb-user USER

  • The owner of files in this package

dir

This package type has no additional options

empty

This package type has no additional options

freebsd

• --freebsd-origin ABI

  • Sets the FreeBSD ‘origin’ pkg field

• --freebsd-osversion VERSION

  • Sets the FreeBSD ‘version’ pkg field, ie 12 or 13, use ‘*’ for all.

gem

• --gem-bin-path DIRECTORY

  • The directory to install gem executables

• --gem-disable-dependency gem_name

  • The gem name to remove from dependency list

• --[no-]gem-embed-dependencies

  • Should the gem dependencies be installed?

• --[no-]gem-env-shebang

  • Should the target package have the shebang rewritten to use env?

• --[no-]gem-fix-dependencies

  • Should the package dependencies be prefixed?

• --[no-]gem-fix-name

  • Should the target package name be prefixed?

• --gem-gem PATH_TO_GEM

  • The path to the ‘gem’ tool (defaults to ‘gem’ and searches your $PATH)

• --gem-git-branch GIT_BRANCH

  • When using a git repo as the source of the gem instead of rubygems.org, use this git branch.

• --gem-git-repo GIT_REPO

  • Use this git repo address as the source of the gem instead of rubygems.org.

• --gem-package-name-prefix PREFIX

  • Name to prefix the package name with.

• --gem-package-prefix NAMEPREFIX

  • (DEPRECATED, use –package-name-prefix) Name to prefix the package name with.

• --[no-]gem-prerelease

  • Allow prerelease versions of a gem

• --gem-shebang SHEBANG

  • Replace the shebang in the executables in the bin path with a custom string

• --gem-stagingdir STAGINGDIR

  • The directory where fpm installs the gem temporarily before conversion. Normally a random subdirectory of workdir.

• --[no-]gem-version-bins

  • Append the version to the bins

npm

• --npm-bin NPM_EXECUTABLE

  • The path to the npm executable you wish to run.

• --npm-package-name-prefix PREFIX

  • Name to prefix the package name with.

• --npm-registry NPM_REGISTRY

  • The npm registry to use instead of the default.

osxpkg

• --osxpkg-dont-obsolete DONT_OBSOLETE_PATH

  • A file path for which to ‘dont-obsolete’ in the built PackageInfo. Can be specified multiple times.

• --osxpkg-identifier-prefix IDENTIFIER_PREFIX

  • Reverse domain prefix prepended to package identifier, ie. ‘org.great.my’. If this is omitted, the identifer will be the package name.

• --osxpkg-ownership OWNERSHIP

  • –ownership option passed to pkgbuild. Defaults to ‘recommended’. See pkgbuild(1).

• --[no-]osxpkg-payload-free

  • Define no payload, assumes use of script options.

• --osxpkg-postinstall-action POSTINSTALL_ACTION

  • Post-install action provided in package metadata. Optionally one of ‘logout’, ‘restart’, ‘shutdown’.

p5p

• --p5p-group GROUP

  • Set the group to GROUP in the prototype file.

• --[no-]p5p-lint

  • Check manifest with pkglint

• --p5p-publisher PUBLISHER

  • Set the publisher name for the repository

• --p5p-user USER

  • Set the user to USER in the prototype files.

• --[no-]p5p-validate

  • Validate with pkg install

• --p5p-zonetype ZONETYPE

  • Set the allowed zone types (global, nonglobal, both)

pacman

• --pacman-compression COMPRESSION

  • The compression type to use, must be one of gz, bzip2, xz, zstd, none.

• --pacman-group GROUP

  • The group owner of files in this package

• --pacman-optional-depends PACKAGE

  • Add an optional dependency to the pacman package.

• --[no-]pacman-use-file-permissions

  • Use existing file permissions when defining ownership and modes

• --pacman-user USER

  • The owner of files in this package

pear

• --pear-bin-dir BIN_DIR

  • Directory to put binaries in

• --pear-channel CHANNEL_URL

  • The pear channel url to use instead of the default.

• --[no-]pear-channel-update

  • call ‘pear channel-update’ prior to installation

• --pear-data-dir DATA_DIR

  • Specify php dir relative to prefix if differs from pear default (pear/data)

• --pear-package-name-prefix PREFIX

  • Name prefix for pear package

• --pear-php-bin PHP_BIN

  • Specify php executable path if differs from the os used for packaging

• --pear-php-dir PHP_DIR

  • Specify php dir relative to prefix if differs from pear default (pear/php)

pkgin

This package type has no additional options

pleaserun

• --pleaserun-chdir CHDIR

  • The working directory used by the service

• --pleaserun-name SERVICE_NAME

  • The name of the service you are creating

• --pleaserun-user USER

  • The user to use for executing this program.

puppet

This package type has no additional options

python

• --python-bin PYTHON_EXECUTABLE

  • The path to the python executable you wish to run.

• --[no-]python-dependencies

  • Include requirements defined by the python package as dependencies.

• --python-disable-dependency python_package_name

  • The python package name to remove from dependency list

• --[no-]python-downcase-dependencies

  • Should the package dependencies be in lowercase?

• --[no-]python-downcase-name

  • Should the target package name be in lowercase?

• --python-easyinstall EASYINSTALL_EXECUTABLE

  • The path to the easy_install executable tool

• --[no-]python-fix-dependencies

  • Should the package dependencies be prefixed?

• --[no-]python-fix-name

  • Should the target package name be prefixed?

• --python-install-bin BIN_PATH

  • (DEPRECATED, does nothing) The path to where python scripts should be installed to.

• --python-install-data DATA_PATH

  • (DEPRECATED, does nothing) The path to where data should be installed to. This is equivalent to ‘python setup.py –install-data DATA_PATH

• --python-install-lib LIB_PATH

  • (DEPRECATED, does nothing) The path to where python libs should be installed to (default depends on your python installation). Want to find out what your target platform is using? Run this: python -c ‘from distutils.sysconfig import get_python_lib; print get_python_lib()’

• --[no-]python-internal-pip

  • Use the pip module within python to install modules - aka ‘python -m pip’. This is the recommended usage since Python 3.4 (2014) instead of invoking the ‘pip’ script

• --[no-]python-obey-requirements-txt

  • Use a requirements.txt file in the top-level directory of the python package for dependency detection.

• --python-package-name-prefix PREFIX

  • Name to prefix the package name with.

• --python-package-prefix NAMEPREFIX

  • (DEPRECATED, use –package-name-prefix) Name to prefix the package name with.

• --python-pip PIP_EXECUTABLE

  • The path to the pip executable tool. If not specified, easy_install is used instead

• --python-pypi PYPI_URL

  • PyPi Server uri for retrieving packages.

• --python-scripts-executable PYTHON_EXECUTABLE

  • (DEPRECATED) Set custom python interpreter in installing scripts. By default distutils will replace python interpreter in installing scripts (specified by shebang) with current python interpreter (sys.executable). This option is equivalent to appending ‘build_scripts –executable PYTHON_EXECUTABLE’ arguments to ‘setup.py install’ command.

• --python-setup-py-arguments setup_py_argument

  • (DEPRECATED) Arbitrary argument(s) to be passed to setup.py

• --python-trusted-host PYPI_TRUSTED

  • Mark this host or host:port pair as trusted for pip

rpm

• --rpm-attr ATTRFILE

  • Set the attribute for a file (%attr), e.g. –rpm-attr 750,user1,group1:/some/file

• --[no-]rpm-auto-add-directories

  • Auto add directories not part of filesystem

• --rpm-auto-add-exclude-directories DIRECTORIES

  • Additional directories ignored by ‘–rpm-auto-add-directories’ flag

• --[no-]rpm-autoprov

  • Enable RPM’s AutoProv option

• --[no-]rpm-autoreq

  • Enable RPM’s AutoReq option

• --[no-]rpm-autoreqprov

  • Enable RPM’s AutoReqProv option

• --rpm-changelog FILEPATH

  • Add changelog from FILEPATH contents

• --rpm-compression none|xz|xzmt|gzip|bzip2

  • Select a compression method. gzip works on the most platforms.

• --rpm-compression-level [0-9]

  • Select a compression level. 0 is store-only. 9 is max compression.

• --rpm-defattrdir ATTR

  • Set the default dir mode (%defattr).

• --rpm-defattrfile ATTR

  • Set the default file mode (%defattr).

• --rpm-digest md5|sha1|sha256|sha384|sha512

  • Select a digest algorithm. md5 works on the most platforms.

• --rpm-dist DIST-TAG

  • Set the rpm distribution.

• --rpm-filter-from-provides REGEX

  • Set %filter_from_provides to the supplied REGEX.

• --rpm-filter-from-requires REGEX

  • Set %filter_from_requires to the supplied REGEX.

• --rpm-group GROUP

  • Set the group to GROUP in the %files section. Overrides the group when used with use-file-permissions setting.

• --[no-]rpm-ignore-iteration-in-dependencies

  • For ‘=’ (equal) dependencies, allow iterations on the specified version. Default is to be specific. This option allows the same version of a package but any iteration is permitted

• --rpm-init FILEPATH

  • Add FILEPATH as an init script

• --[no-]rpm-macro-expansion

  • install-time macro expansion in %pre %post %preun %postun scripts (see: https://rpm-software-management.github.io/rpm/manual/scriptlet_expansion.html)

• --[no-]rpm-old-perl-dependency-name

  • Use older ‘perl’ depdency name. Newer Red Hat (and derivatives) use a dependency named ‘perl-interpreter’.

• --rpm-os OS

  • The operating system to target this rpm for. You want to set this to ‘linux’ if you are using fpm on OS X, for example

• --rpm-posttrans FILE

  • posttrans script

• --rpm-pretrans FILE

  • pretrans script

• --rpm-rpmbuild-define DEFINITION

  • Pass a –define argument to rpmbuild.

• --[no-]rpm-sign

  • Pass –sign to rpmbuild

• --rpm-summary SUMMARY

  • Set the RPM summary. Overrides the first line on the description if set

• --rpm-tag TAG

  • Adds a custom tag in the spec file as is. Example: –rpm-tag ‘Requires(post): /usr/sbin/alternatives’

• --rpm-trigger-after-install '[OPT]PACKAGE: FILEPATH'

  • Adds a rpm trigger script located in FILEPATH, having ‘OPT’ options and linking to ‘PACKAGE’. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html

• --rpm-trigger-after-target-uninstall '[OPT]PACKAGE: FILEPATH'

  • Adds a rpm trigger script located in FILEPATH, having ‘OPT’ options and linking to ‘PACKAGE’. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html

• --rpm-trigger-before-install '[OPT]PACKAGE: FILEPATH'

  • Adds a rpm trigger script located in FILEPATH, having ‘OPT’ options and linking to ‘PACKAGE’. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html

• --rpm-trigger-before-uninstall '[OPT]PACKAGE: FILEPATH'

  • Adds a rpm trigger script located in FILEPATH, having ‘OPT’ options and linking to ‘PACKAGE’. PACKAGE can be a comma seperated list of packages. See: https://rpm-software-management.github.io/rpm/manual/triggers.html

• --[no-]rpm-use-file-permissions

  • Use existing file permissions when defining ownership and modes.

• --rpm-user USER

  • Set the user to USER in the %files section. Overrides the user when used with use-file-permissions setting.

• --[no-]rpm-verbatim-gem-dependencies

  • When converting from a gem, leave the old (fpm 0.4.x) style dependency names. This flag will use the old ‘rubygem-foo’ names in rpm requires instead of the redhat style rubygem(foo).

• --rpm-verifyscript FILE

  • a script to be run on verification

sh

This package type has no additional options

snap

• --snap-confinement CONFINEMENT

  • Type of confinement to use for this snap.

• --snap-grade GRADE

  • Grade of this snap.

• --snap-yaml FILEPATH

  • Custom version of the snap.yaml file.

solaris

• --solaris-group GROUP

  • Set the group to GROUP in the prototype file.

• --solaris-user USER

  • Set the user to USER in the prototype files.

tar

This package type has no additional options

virtualenv

• --virtualenv-find-links PIP_FIND_LINKS

  • If a url or path to an html file, then parse for links to archives. If a local path or file:// url that’s a directory, then look for archives in the directory listing.

• --[no-]virtualenv-fix-name

  • Should the target package name be prefixed?

• --virtualenv-install-location DIRECTORY

  • DEPRECATED: Use –prefix instead. Location to which to install the virtualenv by default.

• --virtualenv-other-files-dir DIRECTORY

  • Optionally, the contents of the specified directory may be added to the package. This is useful if the virtualenv needs configuration files, etc.

• --virtualenv-package-name-prefix PREFIX

  • Name to prefix the package name with.

• --virtualenv-pypi PYPI_URL

  • PyPi Server uri for retrieving packages.

• --virtualenv-pypi-extra-url PYPI_EXTRA_URL

  • PyPi extra-index-url for pointing to your priviate PyPi

• --[no-]virtualenv-setup-install

  • After building virtualenv run setup.py install useful when building a virtualenv for packages and including their requirements from requirements.txt

• --[no-]virtualenv-system-site-packages

  • Give the virtual environment access to the global site-packages

zip

This package type has no additional options