image:https://img.shields.io/github/license/just-sultanov/clj-deps[License,link=LICENSE] image:https://codecov.io/gh/just-sultanov/clj-deps/branch/master/graph/badge.svg[Codecov,link=https://codecov.io/gh/just-sultanov/clj-deps] image:https://github.com/just-sultanov/clj-deps/workflows/build/badge.svg[Build] image:https://github.com/just-sultanov/clj-deps/workflows/deploy/badge.svg[Deploy] image:https://img.shields.io/clojars/v/clj-deps.svg[Clojars, link=https://clojars.org/clj-deps]

== clj-deps

Part of https://github.com/clojure/tools.deps.alpha[org.clojure/tools.deps.alpha] library (add-lib branch)

=== Quick Start Guide

Add the following dependency in your project:

[source,clojure]

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

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

=== Examples

[source,clojure]

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

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

;; load library from git via ssh (deps/add-lib 'clj-fsm {:git/url "[email protected]:just-sultanov/clj-fsm.git" :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 "https://repo.org"}}}) ;; => true

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

=== Development

[source,bash]

Run nREPL & connect from your IDE

$ make repl
nREPL server started on port 7888 on host localhost - nrepl://localhost:7888

=== Testing

[source,bash]

Run tests

$ make test

=== Deploy

[source,bash]

create a new git tag (available types minor, major)

$ make patch

push a new git tag

$ make release

=== Available commands

[source,bash]

$ 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

=== License

link:LICENSE[Copyright © 2019-2020 Ilshat Sultanov]