Romp Documentation

Creating and Publishing Packages

  • Last Modified: 2019-02-14

Romp is invoked as follows:

romp «command»

The «command» is one of the following:

  • pack - Creates a Romp package from the specified directory.
  • publish - Publishes the specified package to a package source.

Pack

romp pack «directory-name» [«output-file-name»] [--overwrite]

If the directory does not represent a valid Romp package, an error is raised and the package is not created. This behavior may be overridden with the --force flag.

The package will be written to the specified fileName or one constructed by the packagename

Arguments and Flags

directory-nameR positional An absolute or relative path of a directory to create. This can be the current working directory, which is specified with a single dot.
output-file-name positional The name of the output file. This can be a relative or absolute path. If it does not end in .upack, an error will be raised unless --force is specified.

When not specified, a file will be placed in the current working directory with a name created based on package name and version from the metadata.
overwrite flag When specified, the output file name will be overwritten if it already exists. Otherwise, an error is raised.

An "R" denotes a required property. When an object is not specified for a variable, a string indicates a required text variable, while a null represents a required text variable without a value.

Publish

romp publish «file-name» [--source=«feedurl»] [--authentication=«api-key-or-username-password»]

Arguments and Flags

file-nameR positional The relative or absolute path to a romp package file.
source value See Common Package Source Arguments..
authentication value See Common Package Source Arguments.

An "R" denotes a required property. When an object is not specified for a variable, a string indicates a required text variable, while a null represents a required text variable without a value.

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.