Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

See the [New Clojure project quickstart](https://blog.michielborkent.nl/new-clojure-project-quickstart.html) blog post for a gentle introduction into `neil`.

## Unreleased

- Auto-generated CLI help via babashka.cli

## 0.3.70

- [#261](https://github.com/babashka/neil/issues/261): `neil dep upgrade` now upgrades unstable deps (e.g. release candidates) to a newer unstable version when no newer stable version exists
Expand Down
57 changes: 12 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,54 +59,21 @@ version to version.
Type `neil` to see the help:

```
Usage: neil <subcommand> <options>
Usage: neil [options] <command>

Most subcommands support the options:
--alias Override alias name.
--deps-file Override deps.edn file name.
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.

Subcommands:
Options:
--version

add
dep Alias for `neil dep add`.
test adds cognitect test runner to :test alias.
build adds tools.build build.clj file and :build alias.
kaocha adds kaocha test runner to :kaocha alias.
nrepl adds nrepl server to :nrepl alias.

dep
add: Adds --lib, a fully qualified symbol, to deps.edn :deps.
Run `neil dep add --help` to see all options.

search: Search Clojars for a string in any attribute of an artifact
Run `neil dep search --help` to see all options.

upgrade: Upgrade libs in the deps.edn file.
Run `neil dep upgrade --help` to see all options.

versions: List available versions of a library (Clojars libraries only)
Run `neil dep versions -h` to see all options.

update: Alias for `upgrade`.

license
list Lists commonly-used licenses available to be added to project. Takes an optional search string to filter results.
search Alias for `list`
add Writes license text to a file
Options:
--license The key of the license to use (e.g. epl-1.0, mit, unlicense). --license option name may be elided when license key is provided as first argument.
--file The file to write. Defaults to 'LICENSE'.

new
Create a project using deps-new
Run `neil new --help` to see all options.

version
Commands for managing the :version key in the deps.edn project config.
Run `neil version --help` to see all options.

test
Run tests. Assumes `neil add test`. Run `neil test --help` to see all options.
Run "neil <command> --help" for more information on a command.
```

### add dep
Expand Down
5 changes: 3 additions & 2 deletions deps.edn
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
babashka/process {:mvn/version "0.4.16"}
rewrite-clj/rewrite-clj {:mvn/version "1.1.46"}
borkdude/rewrite-edn {:mvn/version "0.4.8"}
org.babashka/cli {:mvn/version "0.8.58"}
org.babashka/cli {:mvn/version "0.10.69"}
cheshire/cheshire {:mvn/version "5.11.0"}
io.github.seancorfield/deps-new {:git/url "https://github.com/seancorfield/deps-new"
:git/tag "v0.10.3"
:git/sha "2c012c4"}
version-clj/version-clj {:mvn/version "2.0.2"}}
version-clj/version-clj {:mvn/version "2.0.2"}
clj-kondo/clj-kondo {:mvn/version "2026.05.25"}}
:tools/usage {:ns-default babashka.neil.api}
:aliases
{:neil
Expand Down
Loading
Loading