Home

Welcome to the Shipyard wiki!

Basic Usage

Commands:
   help:               (usage: ship help)                        Show this screen
   dock/install        (usage: ship dock <path> <exec>)          Install a pre-built package (folder or tarball)
   build               (usage: ship build <path> [cfg-args])     Build & install via Makefile/CMake (folder or tarball)
   jettison/uninstall: (usage: ship jettison <package>)          Uninstall a package
   service/update      (usage: ship service [package])           Update the package database/a package
   manifest/list       (usage: ship manifest)                    Displays a list of all installed packages
   inspect                (usage: ship inspect <package>)              Show details for an installed package
   port                (usage: ship port <url> [command])        Use the package list from another port

Creating Ports

Ports are json files containing a list of packages for shipyard.

As an example, here is a package from the default port:

  "gparted": {`
    `"name": "gparted",`
    `"link": "https://sourceforge.net/projects/gparted/files/gparted/gparted-1.8.1/gparted-1.8.1.tar.gz/download",`
    `"version": "1.8.1",`
    `"type": "source"`
  `},

The format for packages is:

• name Name of the executable of the program
• link Link to the .tar/.tar.gz/.tar.xz/etc download of the program
• version The version of the package
• type Type of package, options: binary, source

Binary packages:

Link must be to a binary release
Set type to binary

Source Packages

Link must be to a source release
Set type to source
Supports cmake, make, or meson