1 Using PLane T
2 The PLane T Search Order
3 The planet Command-Line Tool
4 Utility Libraries
5 Developing Packages for PLane T
On this page:
3.1 create
3.2 install
3.3 remove
3.4 show
3.5 clearlinks
3.6 fileinject
3.7 link
3.8 unlink
3.9 fetch
3.10 url
3.11 open
3.12 structure
3.13 print
Version: 4.0.2

 

3 The planet Command-Line Tool

The planet command-line tool allows a command-line interface to the most commonly-performed PLaneT tasks. It is invoked from the command line as

  planet subcommand arg ...

where command is a subcommand from the following list, and arg is a sequence of arguments determined by that subcommand:

Each of these commands is described in more detail below. All the functionality of the command-line tool is also provided with a programmatic interface by the "util.ss" library.

3.1 create

Usage:

  planet create [ <option> ... ] <path>

Create a PLaneT archive in the current directory whose contents are the directory <path>.

<option> is one of:

3.2 install

Usage:

  planet install <owner> <pkg> <maj> <min>

Download and install the package that (require (planet "file.ss" (<owner> <pkg> <maj> <min>))) would install.

3.3 remove

Usage:

  planet remove [ <option> ... ] <owner> <pkg> <maj> <min>

Remove the specified package from the local cache, optionally also removing its distribution file.

<option> is one of:

3.4 show

Usage:

  planet show [ <option> ... ]

List the packages installed in the local cache.

<option> is one of:

3.5 clearlinks

Usage:

  planet clearlinks

Clear the linkage table, allowing upgrades.

3.6 fileinject

Usage:

  planet fileinject <owner> <plt-file> <maj> <min>

Install local file <plt-file> into the planet cache as though it had been downloaded from the planet server. It is treated as though it had the given owner name as its owner name, the given file’s filename as the its package name, and the given major and minor version numbers.

3.7 link

Usage:

  planet link <owner> <pkg> <maj> <min> <path>

Create a development link (see Development Links) between the given package specifier and the specified directory name.

3.8 unlink

Usage:

  planet unlink <owner> <pkg> <maj> <min>

Remove any development link (see Development Links) associated with the given package.

3.9 fetch

Usage:

  planet fetch <owner> <pkg> <maj> <min>

Download the given package file from the central PLaneT repository without installing it.

3.10 url

Usage:

  planet url <owner> <pkg> <maj> <min>

Get a URL for the given package.

This is never necessary for normal use of planet, but may be helpful in some circumstances for retrieving packages.

3.11 open

Usage:

  planet open <plt-file> <target>

Unpack the contents of the given package into the given directory without installing.

This command is not necessary for normal use of planet. It is intended to allow you to inspect package contents offline without needing to install the package.

3.12 structure

Usage:

  planet structure <plt-file>

Print the structure of the PLaneT archive named by <plt-file> to the standard output port.

This command does not unpack or install the named .plt file.

3.13 print

Usage:

  planet print <plt-file> <path>

Print the contents of the file named by <path>, which must be a relative path within the PLaneT archive named by <plt-file>, to the standard output port.

This command does not unpack or install the named .plt file.