Liking cljdoc? Tell your friends :D

License Codecov Build Deploy Clojars


Part of org.clojure/tools.deps.alpha library (add-lib branch)

Quick Start Guide

Add the following dependency in your project:

;; project.clj or build.boot
[clj-deps "RELEASE"]

;; deps.edn
{:deps {clj-deps {:mvn/version "RELEASE"}}}


(ns example
  (:require [clj-deps.core :as deps]))

;; load library from git via https
(deps/add-lib 'clj-fsm {:git/url ""
                        :sha     "396f95a1f28a1fae7672bdf4793e9168abaf2990"})
;; => true

;; load library from git via ssh
(deps/add-lib 'clj-fsm {:git/url ""
                        :sha     "396f95a1f28a1fae7672bdf4793e9168abaf2990"})
;; => true

;; load library from maven
(deps/add-lib 'clj-fsm {:mvn/version "0.2.2"})
;; => true

;; load library from your own repository
(deps/add-lib 'group-id/artifact-id {:mvn/version "1.2.3"}
                                    {:mvn/repos {"repo-name" {:url ""}}})
;; => true

;; load library from local root
(deps/add-lib 'group-id/artifact-id {:local/root "/path/to/file.jar"})
;; => true


# Run nREPL & connect from your IDE
$ make repl
nREPL server started on port 7888 on host localhost - nrepl://localhost:7888


# Run tests
$ make test


# create a new git tag (available types `minor`, `major`)
$ make patch

# push a new git tag
$ make release

Available commands

$ make help
help                           Show help
clean                          Clean
repl                           Run nREPL
lint                           Run linter
test                           Run Clojure tests
build                          Build jar
init                           Init first version
patch                          Increment patch version
minor                          Increment minor version
major                          Increment major version
install                        Install locally
release                        Release a new version
deploy                         Deploy to clojars

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close