You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-6Lines changed: 44 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,16 @@ $ nix-shell -p neil
30
30
# Alternatively, if your nix channel doesn't have neil yet:
31
31
$ nix-shell -I nixpkgs=channel:nixos-unstable -p neil
32
32
```
33
+
### [BBin](https://github.com/babashka/bbin/)
34
+
35
+
```bash
36
+
$ bbin install io.github.babashka/neil
37
+
```
33
38
34
39
### Clojure
35
40
41
+
If possible, use the above methods instead, as this would have a much slower startup. Another problem is that the global `:neil` alias can be overridden by a local one, making it [impossible to use inside the neil repo itself](https://github.com/babashka/neil/issues/246).
42
+
36
43
Add the following alias to your global or project-local `deps.edn`:
37
44
38
45
```clojure
@@ -201,8 +208,8 @@ will return libraries with 'test framework' in their description.
201
208
202
209
### license list
203
210
204
-
List/search for licenses that can be added to a project with `neil`. This functionality uses Github's license API,
205
-
which is also used by [choosealicense.com](https://choosealicense.com/). With no search term, a list of
211
+
List/search for licenses that can be added to a project with `neil`. This functionality uses Github's license API,
212
+
which is also used by [choosealicense.com](https://choosealicense.com/). With no search term, a list of
206
213
commonly-used licenses is returned:
207
214
208
215
```
@@ -241,9 +248,11 @@ $ neil license add epl-1.0
241
248
Will create a LICENSE file in the current directory with the EPL 1.0 text.
[neil.el](https://github.com/babashka/neil/blob/main/neil.el) is a companion Emacs package.
246
254
255
+
### Installation
247
256
Load it using your preferred Emacs package manager, e.g., for Doom Emacs:
248
257
249
258
```emacs-lisp
@@ -254,16 +263,45 @@ Load it using your preferred Emacs package manager, e.g., for Doom Emacs:
254
263
;; config.el
255
264
256
265
(use-package! neil
257
-
:config
266
+
:config
258
267
(setq neil-prompt-for-version-p nil
259
268
neil-inject-dep-to-project-p t))
260
-
261
-
;; by default it attempts to find "neil" somewhere in the $PATH,
262
-
;; but you can set the executable explicitly, e.g.,
269
+
270
+
;; by default it attempts to find "neil" somewhere in the $PATH,
271
+
;; but you can set the executable explicitly, e.g.,
263
272
(setq neil-executable-path "neil-cmd")
264
273
;; or:
265
274
(setq neil-executable-path "clj -M:neil")
275
+
;; see the full list of customizations below
266
276
```
277
+
For a built-in package.el manager you can install it from from [MELPA](https://melpa.org/#/neil) with `M-x package-install` or with `:ensure` keyword from `use-package`.
278
+
279
+
```emacs-lisp
280
+
(use-package neil
281
+
:defer t
282
+
:ensure t
283
+
:custom
284
+
(neil-prompt-for-version-p nil)
285
+
(neil-inject-dep-to-project-p t))
286
+
```
287
+
288
+
### Usage
289
+
290
+
So far, neil.el provides a command `M-x neil-find-clojure-package` that searches for the packages (using `neil dep search`), and generates a dependency string for different Clojure project types.
291
+
292
+
### Customization
293
+
294
+
*`neil-prompt-for-version-p` (default `t`)
295
+
296
+
When non-nil, select from available versions of a lib. Otherwise, use the latest found.
297
+
298
+
*`neil-inject-dep-to-project-p` (default `nil`)
299
+
300
+
When non-nil, try to add library dependency to current project. Otherwise, simply store the dependency string in the `kill-ring'. Works only for deps.edn projects.
301
+
302
+
*`neil-executable-path` (default `nil`)
303
+
304
+
If nil, tries to find neil executable in the PATH. Otherwise uses the given value.
0 commit comments