Package Documentation
Storm Package: vertex
The following Commands are available from this package. This documentation is generated for version 1.4.0 of the package.
Storm Commands
This package implements the following Storm Commands.
vertex.pkg.changelog
Display the changelog for a Storm package in the repository.
Example:
// Display the changelog for the synapse-tor package.
vertex.pkg.changelog synapse-tor
Usage: vertex.pkg.changelog [options] <pkg>
Options:
--help : Display the command usage.
Arguments:
<pkg> : Name of the package to retrieve the changelog for.
vertex.pkg.install
Load a Storm package from the repository.
By default this command will pull the most recent version
of the specified package to install. The ``--version`` argument
can be provided with a version constraint to install a specific
version of the package.
Examples:
// Install the synapse-tor package
vertex.pkg.install synapse-tor
// Install version 3.0.0 of the synapse-tor package
vertex.pkg.install synapse-tor --version 3.0.0
// Install the latest synapse-tor package matching at least version 3.0.0
// and below 4.0.0
vertex.pkg.install synapse-tor --version '>=3.0.0,<4.0.0'
Usage: vertex.pkg.install [options] <pkg>
Options:
--help : Display the command usage.
--version <version> : An optional package version constraint.
--no-verify : Disable package signature verification.
Arguments:
<pkg> : Name of the package to load.
vertex.pkg.list
List the Storm packages available.
By default this command will list all packages which are visible
to your account. The ``--pkg`` argument can also be provided to list
version history for a specific package.
Examples:
// List all packages available
vertex.pkg.list
// Display version history for the synapse-tor package
vertex.pkg.list --pkg synapse-tor
Usage: vertex.pkg.list [options]
Options:
--help : Display the command usage.
--pkg <pkg> : Show detailed information for a specific package.
vertex.pkg.upgrade
Upgrade Storm packages from the repository.
This command will check for upgrades available for currently installed
packages and upgrade them where possible. If the latest version of a package
requires the Cortex to be updated to a newer version of Synapse, a warning
will be displayed and the command will check previous versions of the packages
for compatible upgrades.
By default this command will check all packages for available upgrades. The
``--pkg`` argument can be specified to only check for a specific package.
Examples:
// Upgrade all packages
vertex.pkg.upgrade
// Upgrade the synapse-tor package
vertex.pkg.upgrade --pkg synapse-tor
Usage: vertex.pkg.upgrade [options]
Options:
--help : Display the command usage.
--pkg <pkg> : Specify a package to upgrade.
vertex.register
Register Cortex with the Storm package repository.
Example:
// Register this Cortex with the email address [email protected]
// with the display name 'mycortex'
vertex.register [email protected] --name mycortex
Usage: vertex.register [options] <email>
Options:
--help : Display the command usage.
--name <name> : Optional display name for the Cortex.
Arguments:
<email> : Email address for the account (new or existing) to associate with.
vertex.repo.list
List the Storm package repositories managed by the server.
Example:
// List package repositories present on the server.
vertex.repo.list
Usage: vertex.repo.list [options]
Options:
--help : Display the command usage.
vertex.unregister
Clear the current Cortex registration.
Example:
// Unregister this Cortex so it can be re-registered.
vertex.unregister
Usage: vertex.unregister [options]
Options:
--help : Display the command usage.
Storm Modules
This package does not export any Storm APIs.