Command-line processor 0.2.3 API
Clojure Home

API for clojure.tools.cli - Command-line processor 0.2.3 (in development)

by Gareth Jones
Full namespace name: clojure.tools.cli

Overview

Project home page is http://github.com/clojure/tools.cli/










  

  
Public Variables and Functions

  

    

    

    
cli

    function

    
Usage: (cli args & specs)


    
Parse the provided args using the given specs. Specs are vectors
describing a command line argument. For example:

["-p" "--port" "Port to listen on" :default 3000 :parse-fn #(Integer/parseInt %)]

First provide the switches (from least to most specific), then a doc
string, and pairs of options.

Valid options are :default, :parse-fn, and :flag. See
https://github.com/clojure/tools.cli/blob/master/README.md for more
detailed examples.

Returns a vector containing a map of the parsed arguments, a vector
of extra arguments that did not match known switches, and a
documentation banner to provide usage instructions.

    
    
    Source
  







              

            

          

	

	
      

      
Logo & site design by Tom Hickey.

      Clojure auto-documentation system by Tom Faulhaber.