Helm interface to CIDER
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
.gitignore
CHANGELOG.md
README.md
helm-cider-cheatsheet.el
helm-cider-repl.el
helm-cider-spec.el
helm-cider-util.el
helm-cider.el

README.md

MELPA License GPL 3

Helm Cider

Helm interface to CIDER.

Installation

Install via MELPA.

For general information on installing Emacs packages, see the Emacs Wiki.

Setup

In your init file, add the following to activate helm-cider-mode and use Helm versions of CIDER commands:

(helm-cider-mode 1)

Use M-x helm-cider-mode to turn the minor mode off, or call

(helm-cider-mode -1)

Features

The following assumes that helm-cider-mode is turned on, and that the reader is familiar with Helm functionality.

Apropos

Calling cider-apropos or cider-apropos-select brings up a Helm buffer of all symbols across all namespaces (except those excluded using the helm-cider-apropos-excluded-ns customizable variable).

Each Helm source is a namespace. To select a namespace, use C-c n (the default value of helm-cider-apropos-ns-key) and select the desired namespace.

Apropos

Apropos documentation

Calling cider-apropos-documentation or cider-apropos-documentation-select brings up a Helm buffer of all symbols across all namespaces with documentation.

Select a namespace as with normal apropos.

If customizable variable helm-cider-apropos-full-doc is t, show full instead of short documentation. Toggle between full/short documentation with C-].

Apropos documentation

Namespaces

Calling cider-browse-ns or cider-browse-ns-all brings up a Helm buffer of namespaces.

Use RET to select a namespace and view symbols in that namespace without documentation. Use S-RET to select a namespace and view symbols in that namespace with documentation.

Browse namespaces

Specs

Calling helm-cider-spec brings up a Helm buffer of all spec names across all namespaces.

Each Helm source is a namespace. To select a namespace, use C-c n (the default value of helm-cider-spec-ns-key) and select the desired namespace.

Specs

Spec namespaces

Calling helm-cider-spec-ns brings up a Helm buffer of spec namespaces.

Use RET to select a namespace and view spec names in that namespace.

Spec namespaces

REPL history

Calling helm-cider-repl-history (bound to C-c C-l by default) in a CIDER REPL brings up a Helm buffer of REPL entries.

Use RET to select an entry and insert it into the REPL.

Use f2 to delete an entry from history. Multiple entries can be marked and deleted.

REPL History

Clojure cheatsheet

Calling helm-cider-cheatsheet brings up a Clojure cheatsheet. This is largely a port of @krisajenkins's clojure-cheatsheet.

Matches are against both candidates and categories. For example, arith will match against the Primitives : Numbers : Arithmetic category.

Clojure cheatsheet

See Also

  • CIDER issue #1541, regarding Ido/Helm support for apropos.
  • CIDER issue #1059, regarding seeing more completion candidates and grouping them by namespace.
  • helm-clojure, an earlier project with similar ideas.