nvdnkpr / freight

Freight - Experimental Bundling Server for NPM and Bower

# Freight ### Experimental Bundling Server for [NPM](https://www.npmjs.org/) and [Bower](http://bower.io/)

Try it out

Install npm install -g freight.

Get the sample project:

git clone https://github.com/vladikoff/freight-sample.git && cd freight-sample

Run freight -u http://freight.vf.io, you will now have the NPM and Bower modules!

Features

• Tiny command line tool with a speedy install. Uses one NPM module request.
• Works with package.json and bower.json dependencies and devDependencies.
• No configuration files required.
• Works great with continuous integration environments.
• Dashboard to manage bundle files and bundle queues:

How it works

Freight consists of two components: a command line tool and a hosted cache server. See the Freight Server README to help you setup a Freight Server.

Create bundles

Freight Server saves node_modules and bower_components into compressed tar.gz bundles. The bundles are created based on your package.json and bower.json, using the --create command. This action requires the server password. You can use --force to recreate the bundle.

Run the command below from a project directory with a package.json or bower.json file:

freight -u http://YOUR_SERVER.com --create -p=SERVER_PASSWORD
************

Bundle does not exist for this project.
Freight Server will now generate a bundle.
Monitor your Freight at http://YOUR_SERVER.com/freights/active

************

Download bundles

You can monitor created and queued bundles using the web interface available at http://YOUR_SERVER.com. The web interface is protected with the same Freight server password.

To download the bundle that was created earlier just use the freight -u=http://YOUR_SERVER.com command from the project directory. This will extract node_modules and bower_components from the bundle.

$ freight -u http://YOUR_SERVER.com
Downloading bundle: ||||||||||||||||||| 100% 0.0s 4.2 MB
Extracting bundle...
Freight is done in 3.613 seconds.

CLI Options

$ freight --help

--help
 -h Display help.

--url
 -u Freight Server URL. Example: "http://example.com"

--verbose
 -v Verbose mode. A lot more information output.

--create
 -c Create a bundle on a remote server. Requires password.

--password
 -p Remote Freight Server password to create Freight bundles.

--force
 -f A way to force create a bundle. Requires password and create commands.

--silent
  No output.

Author

Vlad Filippov

Release History

See the CHANGELOG.