https://github.com/clojure-emacs/helm-cider
Helm interface to CIDER
https://github.com/clojure-emacs/helm-cider
cider clojure emacs helm
Last synced: 5 months ago
JSON representation
Helm interface to CIDER
- Host: GitHub
- URL: https://github.com/clojure-emacs/helm-cider
- Owner: clojure-emacs
- Created: 2016-04-20T22:54:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T09:44:43.000Z (over 3 years ago)
- Last Synced: 2025-06-08T05:10:52.108Z (6 months ago)
- Topics: cider, clojure, emacs, helm
- Language: Emacs Lisp
- Size: 680 KB
- Stars: 65
- Watchers: 8
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://melpa.org/#/helm-cider)
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
# Helm Cider
[Helm](https://github.com/emacs-helm/helm) interface to [CIDER](https://github.com/clojure-emacs/cider).
## Installation
Install via [MELPA](https://melpa.org/#/).
For general information on installing Emacs packages, see the [Emacs Wiki](https://www.emacswiki.org/emacs/InstallingPackages).
## Setup
In your init file, add the following to activate `helm-cider-mode` and use Helm versions of CIDER commands:
```emacs-lisp
(helm-cider-mode 1)
```
Use `M-x helm-cider-mode` to turn the minor mode off, or call
```emacs-lisp
(helm-cider-mode -1)
```
## Features
The following assumes that `helm-cider-mode` is turned on, and that the reader is familiar with [Helm](https://github.com/emacs-helm/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 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-]`.
### 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.
### 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.
### Spec namespaces
Calling `helm-cider-spec-ns` brings up a Helm buffer of [spec](https://clojure.org/about/spec) namespaces.
Use `RET` to select a namespace and view spec names in that namespace.
### 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.
### Clojure cheatsheet
Calling `helm-cider-cheatsheet` brings up a Clojure cheatsheet. This is largely a port of @krisajenkins's [`clojure-cheatsheet`](https://github.com/clojure-emacs/clojure-cheatsheet).
Matches are against both candidates and categories. For example, `arith` will match against the `Primitives : Numbers : Arithmetic` category.
## See Also
- CIDER issue [#1541](https://github.com/clojure-emacs/cider/issues/1541), regarding [Ido](https://www.gnu.org/software/emacs/manual/html_mono/ido.html)/Helm support for `apropos`.
- CIDER issue [#1059](https://github.com/clojure-emacs/cider/issues/1059), regarding seeing more completion candidates and grouping them by namespace.
- [helm-clojure](https://github.com/prepor/helm-clojure), an earlier project with similar ideas.
[badge-license]: https://img.shields.io/badge/license-GPLv3-blue.svg