Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Project management tool for Emacs

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
templates
test
.gitignore
.travis.yml
Carton
Makefile
README.md
carton-pkg.el
carton.el
carton.png
go

README.md

Carton Build Status

Carton

Carton for Emacs is what Bundler is to Ruby. It aims to make ELPA dependency management in Emacs painless (as painless as it can be). This includes both your local Emacs installation and Emacs package development.

Installation

To automatically install Carton, run this command:

curl -fsSkL https://raw.github.com/rejeep/carton/master/go | sh

You can also clone the repository.

$ git clone https://github.com/rejeep/carton.git

Don't forget to add Carton's bin to your PATH.

$ export PATH="/path/to/code/carton/bin:$PATH"

Usage

Create a file called Carton in your project root and specify dependencies:

$ carton init

To install all dependencies, run:

$ carton [install]

This will create a directory called elpa, containing all dependencies.

To update package version, run:

$ carton update

Local Emacs installation

Add this to your .emacs file.

(require 'package)
(package-initialize)

That's it!

To automatically keep the Carton file up to date with what you install from ELPA, check out https://github.com/rdallasgray/pallet.

Package development

To create a -pkg.el file, run:

$ carton package

To run some Emacs Lisp code with ELPA load paths all set up for you, use:

$ carton exec [COMMAND]

Example:

$ carton exec make test

To list all dependencies:

$ carton list

DSL

source

Add an ELPA mirror.

(source NAME URL)

Example:

(source "melpa" "http://melpa.milkbox.net/packages/")

package

Define this package (used only for package development).

(package NAME VERSION DESCRIPTION)

Example:

(package "ecukes" "0.2.1" "Cucumber for Emacs.")

depends-on

Add a runtime dependency.

(depends-on NAME VERSION)

Example:

(depends-on "magit" "0.8.1")

package-file

Define this package and its runtime dependencies from the package headers of a file (used only for package development). The name of the file is relative to the directory containing the Carton file.

(package-file FILENAME)

Example:

(package-file "foo.el")

development

Set scope to development dependencies.

(development [DEPENDENCIES])

Example:

(development
 (depends-on "ecukes" "0.2.1")
 (depends-on "espuds" "0.1.0"))

Example

Local Emacs installation

(source "melpa" "http://melpa.milkbox.net/packages/")

(depends-on "magit")
(depends-on "drag-stuff")
(depends-on "wrap-region")

Package development

(source "melpa" "http://melpa.milkbox.net/packages/")

(package "ecukes" "0.2.1" "Cucumber for Emacs.")

(depends-on "ansi")

(development
 (depends-on "el-mock")
 (depends-on "ert"))

I still don't get it, give me some real examples

These are some projects using Carton:

Contribution

Be sure to!

Run the tests with:

$ make
Something went wrong with that request. Please try again.