Quick Tour of Pak

Installing Paks

To install named packages:

pak install NAME...

Where NAME can be the name of a package published in the Pak catalog, NPM or bower catalog, a GitHub repository endpoint, a GitHub account/repository or a path to a local package directory. Here are some of the forms you can use to install packages.

pak install jquery pak install jquery pak install npm:jquery pak install bower:jquery pak install https://github.com/embedthis/jquery.git pak install git@github.com:embedthis/jquery pak install embedthis/jquery

When a package is installed, all required dependent packages will be automatically installed.

Installing Specific Versions

A PAK name may have a #version suffix that nominates a specific version to install. pak install 'jquery#2.1.3'

To install all the packages required by an application as specified in its package.json:

pak install

Removing Paks

To uninstall a package from your local directory. The package will remain in the local Pak cache under ~/.paks.

pak uninstall PAK...

List Paks

To list installed packages in your local directory:

pak list

The list will display the package name, installed version and from where the package was downloaded. Paks may designated as optional if the package.json describes them in the 'optionalDependencies' list.

Pak Dependencies

To display dependencies for installed packages in your local directory

pak depend

This will display the installed packages and their dependencies with versions.

Cached Paks

When Pak installs a package, it keeps a copy of the package in the Pak cache which is typically at ~/.paks. The cache stores all versions downloaded of a Pak.

pak cached

Pre-Caching

To download and cache a package but not install in the local directory

pak cache Name

Pruning Paks

To prune old versions from the cache

pak prune Name

© Embedthis Software, 2003-2015. All rights reserved.