https://github.com/kriszyp/cpm

CommonJS Package Manager
https://github.com/kriszyp/cpm

Last synced: about 2 months ago
JSON representation

CommonJS Package Manager

• Host: GitHub
• URL: https://github.com/kriszyp/cpm
• Owner: kriszyp
• Created: 2010-09-04T04:31:00.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2014-05-08T02:58:29.000Z (over 10 years ago)
• Last Synced: 2024-11-02T01:50:29.927Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://dojotoolkit.org/
• Size: 1.15 MB
• Stars: 94
• Watchers: 13
• Forks: 21
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
CPM (CommonJS Package Manager) is designed for simple, straightforward installation

of CommonJS packages into a target location/package. This is specifically designed to

make it easy to install packages for use in the browser or any server side JS

environment (like Node). CPM is based on the CommonJS Mappings specification,

and will install all dependencies listed in the dependencies or mappings hash.

# Installation

Download and unzip/untar CPM. Then edit the startup script (cpm for unix or cpm.bat

for windows) to point to the path where you have put CPM, and copy the script into

a directory in your path (like /usr/local/bin in unix or C:\windows in windows). You

can also modify the registry URL in the startup script as well. The startup script also

includes directions (in the comments) for running from Node instead of Rhino.

A quick one-line install on Mac OS and Linux is:

	curl -L https://raw.github.com/kriszyp/cpm/master/install | sh

To install to a different location, you can use CPM_INSTALL_LIB for the directory where

to put cpm's directory and CPM_INSTALL_BIN for the directory to symlink the cpm script:

    curl -L https://raw.github.com/kriszyp/cpm/master/install | CPM_INSTALL_LIB=~/lib CPM_INSTALL_BIN=~/bin sh

This would install cpm's libraries in "~/lib/cpm" and symlink the cpm script to "~/bin/cpm".

Make sure that your ~/lib directory exists before doing this.

If you are running on Mac OS, then you will probably need to edit the cpm script (the one

that "which cpm" points to) and manually set CPM_PATH to your CPM folder that holds the 

jars and lib directory.  

# Usage

The main use of CPM is to install packages. To install a package, go to the directory

where your JavaScript is stored and where you want your packages to be installed and run:

    cpm install package-to-install

The packages will be downloaded and unzipped into the current working directory. CPM

will also create any top level package modules to point to package "main" modules.

You should be able to load the modules with any AMD compliant module loader, including

RequireJS, Dojo, or Curl. For example:

    

    

        require(["some-package/some-module"]);

    

You can also indicate the desired version to install with a second parameter:

    cpm install package-to-install 1.2.2

To upgrade a package to the latest version, you can run:

    cpm upgrade package-to-upgrade

To specify a directory to install packages to, you can run:

    cpm --packages-path=~/Projects/my_project/libs install package-to-install

To specify a different registry to install packages from, you can run:

    cpm --registry=http://url.to.registry.com install package-to-install

Licensing

--------

CPM is licensed under the AFL or BSD license. It is administered under the Dojo foundation,

and all contributions require a Dojo CLA.