Shipwright::Manual::Tutorial - Shipwright tutorial


In this tutorial, we'll create a vessel to demonstrate the basic operation of Shipwright.



Shipwright ships with command line tool shipwright which allows you to manage shipyard: create, import sources, "update", and so on.

Let's start from a new shipyard.

Create a new shipyard

shipyard - the place where all source code lives. Shipwright supports several backends: SVK, SVN, Git and plain file system. We'll use FS in this tutorial.

Let's create a new shipyard:

    $ shipwright create -r fs:/tmp/foo

To avoid typing -r fs:/tmp/foo all the time you can use "SHIPWRIGHT_SHIPYARD" environment variable.

    $ export SHIPWRIGHT_SHIPYARD="fs:/tmp/foo"

From now on we don't need the "-r ..." for the session.

Import sources

Our shipyard is worthless if it doesn't contain any source, let's import some.

Shipwright supports various types of sources. Here are some examples:

compressed file
plain directory

fs:/tmp/shipyard is another shipyard, 'foo' or 'bar' is the source name we want to import.

We'll import apache 2.2.9, perl 5.10, mod_perl 2.0, libxml and XML::LibXML in this tutorial one by one.

    $ shipwright import --name apache
    $ shipwright import
    $ shipwright import --name mod_perl --no-follow
    ( use --no-follow is because run Makefile.PL will hung if we don't have
      apache installed )
    $ shipwright import --name libxml
    $ shipwright import cpan:XML::LibXML

Run shipwright help import to see more options.

As a side note, if we were importing from a source that doesn't use a build mechanism that Shipwright can automatically create a set of build instructions for (currently autoconf, ExtUtils::MakeMaker, Module::Install, and Module::Build), we would now need to edit scripts/SOURCE_NAME/build to tell Shipwright how to build that source.

For our tutorial, e.g. perl 5.10, Shipwright doesn't know about the peculiarities of how to build perl, so we need to edit the build file:

  configure: ./Configure -des -Dprefix=%%INSTALL_BASE%%
  test: %%MAKE%% test
  install: %%MAKE%% install

For more information on build scripts, see Shipwright::Manual::CustomizeBuild.


For dists with CPAN, SVK, SVN, Git and shipyard types, we can simply use the update command to update:

    $ shipwright update cpan-XML-LibXML
    (yeah, that's right, cpan:XML::LibXML will be named cpan-XML-LibXML)

We can also specify the version we want to update to with --version argument:

    $ shipwright update cpan-XML-LibXML --version 1.60

For other types, Shipwright can't guess the latest version, so we have to tell Shipwright where it is using the relocate command.

e.g. apache 2.2.10 is released one day, with download link, we need to set the source URL first before updating.

    $ shipwright relocate apache 
    $ shipwright update apache

tweak manually

You may find that cpan-XML-LibXML needs libxml as a dependency, but in /scripts/cpan-XML-LibXML/require.yml there's no such entry, because require.yml is created automatically, filled with perl module dists, no extra dependences will be set.

So we need to do it manually, e.g. use the following command to do so:

    $ shipwright update cpan-XML-LibXML --add-deps libxml


We need to checkout the repository into some directory first, then chdir there, and run: (for FS backend, there's no need to checkout, just chdir to /tmp/foo ),

$ ./bin/shipwright-builder --install-base /tmp/vessel

Run ./bin/shipwright-builder --help to see more options and ./bin/shipwright-builder --advanced-help to see even more options.

fiddle the vessel

We can use bin/shipwright-filter to fiddle the vessel, e.g. removing pods. Run ./bin/shipwright-filter --help to see more options

ship our vessel

We call the built source the vessel.

To ship our vessel, create an archive of the built files using an archive program such as tar, e.g. by running tar czvf vessel.tar.gz /tmp/vessel.

Users can use our vessel by extracting the archive to a directory and then adding the following command to their shell's startup script (e.g. for bash users, edit /home/user/.bashrc on most systems): source /base/path/tools/etc/shipwright-source-bash (for bash users). A source script is also provided for the tcsh shell.

Here is a sourcing example:

  source /home/user/myapp/tools/shipwright-source-bash /home/user/myapp

This example assumes the myapp vessel was extracted to /home/user/myapp.

After sourcing this script, users will be able to run binaries and load perl modules from our vessel as with normal installed programs, though they will need to start a new shell or re-run their startup script.

ship shipyard

If you want to ship a shipyard instead of the vessel, you can just tar your shipyard( i.e. "/tmp/foo" ) and ship it, though Shipwright supplies a convenient way too:

Let's chdir to our shipyard first, then run: $ ./bin/shipwright-utility --generate-tar-file /tmp/

The is a shipyard perl script working like "shipwright-builder" but it's self contained, so you can build a vessel with like this:

$ perl /tmp/ --install-base /tmp/vessel


Shipwright, Shipwright::Manual


sunnavy <>


Shipwright is Copyright 2007-2015 Best Practical Solutions, LLC.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.