Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Project management tool for Emacs
Emacs Lisp Python Cucumber Makefile Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
etc
features
server
templates
.gitignore
.travis.yml
Cask
Makefile
README.md
cask-cli.el
cask.el
cask.png
epl-legacy.el
epl-package-desc.el
epl.el
go
package-legacy.el

README.md

Cask Build Status

Cask

Cask 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.

Migration from Carton

This project was previously named Carton, but because of a name clash with another project, this project was renamed to Cask. A few things needs to be done to migrate:

  1. Use the cask command instead of the carton command
  2. If your Emacs configuration dependes on carton, depend on cask instead:

    (depends-on "carton") => (depends-on "cask")

  3. Rename the file Carton to Cask

  4. Rename the installation directory (default ~/.carton) to ~/.cask (don't forget to update the path in you shell config)

(And ohh, don't forget to update your .travis.yml and .gitignore files)

Installation

To automatically install Cask, run this command:

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

You can also clone the repository.

$ git clone https://github.com/rejeep/cask.el.git

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

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

Usage

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

$ cask init [--dev]

(Use --dev if the project is for package development)

To install all dependencies, run:

$ cask [install]

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

To update package version, run:

$ cask update

To list all dependencies, run:

$ cask list

Emacs configuration

Add this to your .emacs file.

(require 'cask "~/.cask/cask.el")
(cask-initialize)

Tips

To automatically keep the Cask 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:

$ cask package

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

$ cask exec [COMMAND]

Example:

$ cask exec make test

To print info about the current project:

$ cask info

DSL

source

Add an ELPA mirror.

(source ALIAS)
(source NAME URL)

Example:

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

Available sources:

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 Cask 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)

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

Package development

(source melpa)

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

(depends-on "ansi")

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

Completion

To install ZSH completion add the following to your ~/.zshrc:

source /path/to/code/cask/etc/cask_completion.zsh

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

These are some projects using Cask:

Contribution

Be sure to!

For each make command below, prefix with:

$ EMACS="/path/to/emacs"

For exmaple:

$ EMACS="/path/to/emacs" make abc

Run the unit tests with:

$ make unit

To run the Ecukes tests, first start the fake ELPA server:

$ make server

Then to run the tests:

$ make ecukes

Run all tests with:

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