Clojure CLI command line tool

Open
#442 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
clojure
Domain
cli

Research direction

Start by reviewing the supplied Clojure CLI template and the repository's existing clojure-cli examples or entry points, if any. No target file, test, or acceptance criteria are named, so confirm where the template belongs and what command behavior is expected before making changes.

Written by the indexing model from the issue text.

Description

A basic template for creating a Clojure CLI command tool.

   (ns practicalli.tool-name
    (:gen-class)
    (:require [clojure.tools.cli :as cli]))

  (def VERSION "0.0.1")

  (def cli-opts
    [["-v" "--verbose" "Increase verbosity" :default 0 :update-fn inc]
     [nil  "--version" "Print version and exit"]
     ["-h" "--help" "Print this help information"]])

  (defn exec-tool [args {:keys [] :as opts}]
    ;; main functionality goes here, you get a seq of positional arguments, and a
    ;; map of options.
    )

  (defn -main [& args]
    (let [{:keys [errors options arguments summary]} (cli/parse-opts args cli-opts)]
      (cond
        (seq errors)
        (do
          (run! println errors)
          (println summary)
          (System/exit -1)) ;; non-zero exit code if something goes wrong

        (:help options)
        (do
          (println summary)
          (System/exit 0))

        (:version options)
        (do
          (println VERSION)
          (System/exit 0))

        :else
        (main arguments options))))
Dominant language
Makefile
Stars
117
Forks
36
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from practicalli/clojure

All issues in practicalli/clojure

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.