A CLI to add common aliases and features to deps.edn-based projects.
See the New Clojure project quickstart blog post for a gentle introduction into neil.
$ brew install babashka/brew/neil
If you installed neil before Homebrew introduced tap
trust, you may see a warning like Skipping neil: tap formula is not trusted. To fix this, run:
$ brew trust babashka/brew/neil
$ scoop bucket add scoop-clojure https://github.com/littleli/scoop-clojure
$ scoop install neil
For detailed information about scoop installer check scoop-clojure.
$ nix-shell -p neil
# Alternatively, if your nix channel doesn't have neil yet:
$ nix-shell -I nixpkgs=channel:nixos-unstable -p neilAdd the following alias to your global or project-local deps.edn:
:neil {:deps {io.github.babashka/neil {:git/tag "v0.3.71"
:git/sha "78e11f7"}}
:main-opts ["-m" "babashka.neil"]}Then invoke clj -M:neil.
- Install babashka 1.13.229 or later
- Download the
neilscript to somewhere on yourPATH. In Windows, also download theneil.batscript and place it in thePATH.
Add the line for your shell to its init file.
Bash:
source <(neil org.babashka.cli/completions snippet --shell bash)Zsh, after compinit:
source <(neil org.babashka.cli/completions snippet --shell zsh)Fish:
neil org.babashka.cli/completions snippet --shell fish | sourcePowerShell, in $PROFILE:
neil org.babashka.cli/completions snippet --shell powershell | Out-String | Invoke-ExpressionSee the babashka.cli completions docs for other shells.
As we're still finding out the best UX, neil may undergo breaking changes from
version to version.
Type neil to see the help:
Usage: neil [options] <command>
Commands:
add Add a dep, test runner, build or nREPL alias.
dep Manage dependencies.
license Find and add a license.
new Create a project from a deps-new template.
version Show or manage the project version.
test Run tests (assumes `neil add test`).
help Show this help.
Options:
--version
Run "neil <command> --help" for more information on a command.
This will add the newest version of clj-kondo to the :deps map in deps.edn:
$ neil add dep :lib clj-kondo/clj-kondo
The :lib keyword may be elided if the libname is the first argument after dep:
$ neil add dep clj-kondo/clj-kondo
The add dep command will always overwrite an existing dependency.
To add a git library from Github you can use :sha to provide a SHA or
:latest-sha to pick the latest sha from the default branch:
$ neil add dep org.babashka/sci :latest-sha true
To add tools.build related features, use:
$ neil add build :deps-deploy true
After that you can run tasks like:
$ clojure -T:build uber
$ clojure -T:build deploy
If you didn't use the full app template when starting your project, then you'll need to configure a couple things in order to get a working uberjar. See the uberjar section here.
$ neil add testThis will add the Cognitect
test-runner to your deps.edn
so you can execute:
$ clojure -X:testA similar option is supported for kaocha:
$ neil add kaocha
To change the alias you can provide an option like:
$ neil add kaocha :alias kaocha2
Search Clojars for a string in any attribute of an artifact:
$ neil dep search "babashka.nrepl"
:lib babashka/babashka.nrepl :version 0.0.6
Note that Clojars stores the namespace and name of a library as separate attributes, so searching for a ns-qualified library will not necessarily return any matches:
$ neil dep search "babashka/babashka.nrepl"
Unable to find babashka/babashka.nrepl on Clojars.
But a search string can be matched in a library's description:
$ neil dep search "test framework"
will return libraries with 'test framework' in their description.
List/search for licenses that can be added to a project with neil. This functionality uses Github's license API,
which is also used by choosealicense.com. With no search term, a list of
commonly-used licenses is returned:
$ neil license list
:license agpl-3.0 :name GNU Affero General Public License v3.0
:license apache-2.0 :name Apache License 2.0
...
A search term can be added to filter the commonly-used list with a case-insensitive search against the license name:
$ neil license list "lesser general"
:license lgpl-2.1 :name GNU Lesser General Public License v2.1
The full collection of available licenses can be found in the license API repo.
license search is an alias for license list.
Retrieve license text from Github's license API and write it to a file. See the license list help for details on available licenses.
$ neil license add :license mit :file myproj/license.txt
Will write the MIT license to the file myproject/license.txt. The :license keyword can be left out if the license key is the first argument,
and :file defaults to LICENSE, so a minimal usage:
$ neil license add epl-1.0
Will create a LICENSE file in the current directory with the EPL 1.0 text.
neil.el is a companion Emacs package.
Load it using your preferred Emacs package manager, e.g., for Doom Emacs:
;; packages.el
(package! neil :recipe (:host github :repo "babashka/neil" :files ("*.el")))
;; config.el
(use-package! neil
:config
(setq neil-prompt-for-version-p nil
neil-inject-dep-to-project-p t))
Github's API has a 60 hit/hour rate-limit. The workaround for this is creating a personal access token and setting two env vars:
NEIL_GITHUB_USERNEIL_GITHUB_TOKEN
- Add
bb.edn-related features for invokingtestandbuildtasks - Option to add
cljs-test-runner
If this project shows potential to you, I'd be happy to discuss and receive contributions.
See neil.rb for the brew Formula. You can install this formula locally with:
$ brew reinstall --build-from-source ./neil.rb
Or install a development version with bbin:
$ bbin install . --as neil-dev --main-opts '["-m" "babashka.neil/-main"]'
You can choose your own binary name with the --as YOUR_BINARY option.
Rebuilding is not required when installing with bbin - any changes to
src/babashka/neil.clj will count the next time you run neil-dev
(YOUR_BINARY).
Copyright © 2022 Michiel Borkent
Distributed under the MIT License. See LICENSE.