https://github.com/ericdallo/deps-bin

A Clojure library that builds an executable containing a embedded jar inside
https://github.com/ericdallo/deps-bin

bin cli clojars clojure clojure-cli deps deps-edn executable library

Last synced: 12 days ago
JSON representation

A Clojure library that builds an executable containing a embedded jar inside

• Host: GitHub
• URL: https://github.com/ericdallo/deps-bin
• Owner: ericdallo
• License: epl-2.0
• Created: 2021-03-22T18:28:11.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T11:47:32.000Z (10 months ago)
• Last Synced: 2024-10-12T00:29:38.373Z (28 days ago)
• Topics: bin, cli, clojars, clojure, clojure-cli, deps, deps-edn, executable, library
• Language: Clojure
• Homepage:
• Size: 51.8 KB
• Stars: 21
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Clojars Project](https://img.shields.io/clojars/v/com.github.ericdallo/deps-bin.svg)](https://clojars.org/com.github.ericdallo/deps-bin)

# deps-bin

A Clojure library that builds an executable containing a embedded jar inside.

This library is a `deps.edn` only alternative for [lein-binplus](https://github.com/BrunoBonacci/lein-binplus). It will create a executable file that exec `java -jar` with the provided jvm options, so you still need `java` on your `$PATH`.

On MS-Windows, the executable has a `.bat` extension, since technically it is a script calling java with an embedded jar file.

## Usage

To generate a executable, simply merge:

```clojure

{:bin {:extra-deps {com.github.ericdallo/deps-bin {:mvn/version "RELEASE"}}

       :exec-fn deps-bin.deps-bin/bin

       :exec-args {:jar "my-jar.jar" 

                   :name "my-bin"}}}

```

into your deps.edn, and build with:

``` bash

$ clojure -X:bin

```

and it should generate a executable that you can run with:

``` bash

./my-bin

```

In this example, it expects that you have a jar `my-jar.jar`, you can generate it with [depstar](https://github.com/seancorfield/depstar), for example:

``` bash

$ clojure -X:jar && clojure -X:bin

```

## Other options

- `:help` true              -- show this help (and exit)

- `:jar` sym-or-str         -- specify the source name of the JAR file

- `:name` sym-or-str        -- specify the name of the generated BIN file

- `:skip-realign` true      -- if should skip byte alignment repair.

- `:jvm-opts` [strs]        -- optional list of JVM options to use during bin executing

- `:platforms` [kws]        -- optional list of platforms for which to emit bins, valid kws: :unix, :windows, defaults to system platform

## Contribution

Contributions are very welcome, please open an issue or a pull request if inspired :)