Liking cljdoc? Tell your friends :D

nrepl.cmdline

A proof-of-concept command-line client for nREPL. Please see e.g. REPL-y for a proper command-line nREPL client @ https://github.com/trptcolin/reply/

A proof-of-concept command-line client for nREPL.  Please see
e.g. REPL-y for a proper command-line nREPL client @
https://github.com/trptcolin/reply/

-main

(-main & args)
source

ack-server

(ack-server server options)

Acknowledge the port of this server to another nREPL server running on :ack port. Takes nREPL server map and processed CLI options map. Prints a message describing the acknowledgement between servers. Returns nil.

Acknowledge the port of this server to another nREPL server running on
:ack port.
Takes nREPL server map and processed CLI options map.
Prints a message describing the acknowledgement between servers.
Returns nil.
sourceraw docstring

args->cli-options

(args->cli-options args)

Takes CLI args list and returns vector of parsed options map and remaining args.

Takes CLI args list and returns vector of parsed options map and
remaining args.
sourceraw docstring

colored-output

source

connect-to-server

(connect-to-server {:keys [host port transport], :as options})

Connects to a running nREPL server and runs a REPL. Exits program when REPL is closed. Takes a map of nREPL CLI options.

Connects to a running nREPL server and runs a REPL. Exits program when REPL
is closed.
Takes a map of nREPL CLI options.
sourceraw docstring

connection-opts

(connection-opts options)

Takes map of nREPL CLI options Returns map of processed options used to connect or start a nREPL server.

Takes map of nREPL CLI options
Returns map of processed options used to connect or start a nREPL server.
sourceraw docstring

die

(die & msg)

Prints items in msg to err and then exits with a status of 2.

`Print`s items in `msg` to *err* and then exits with a status of 2.
sourceraw docstring

dispatch-commands

(dispatch-commands options)

Look at options to dispatch a specified command. Takes CLI options map. May return a server map, nil, or exit.

Look at options to dispatch a specified command.
Takes CLI options map. May return a server map, nil, or exit.
sourceraw docstring

display-help

(display-help)

Prints the help copy to the screen and exits the program with exit code 0.

Prints the help copy to the screen and exits the program with exit code 0.
sourceraw docstring

display-version

(display-version)

Prints nREPL version to the screen and exits the program with exit code 0.

Prints nREPL version to the screen and exits the program with exit code 0.
sourceraw docstring

exit

(exit status)

Requests that the process exit with the given status. Does not return.

Requests that the process exit with the given `status`.  Does not
return.
sourceraw docstring

help

(help)
source

interactive-repl

(interactive-repl server options)

Runs an interactive repl if :interactive CLI option is true otherwise puts the current thread to sleep Takes nREPL server map and processed CLI options map. Returns nil.

Runs an interactive repl if :interactive CLI option is true otherwise
puts the current thread to sleep
Takes nREPL server map and processed CLI options map.
Returns nil.
sourceraw docstring

parse-cli-values

(parse-cli-values options)

Converts relevant command line argument values to their config representation.

Converts relevant command line argument values to their config
representation.
sourceraw docstring

repl-intro

(repl-intro)

Returns nREPL interactive repl intro copy and version info as a new-line separated string.

Returns nREPL interactive repl intro copy and version info as a new-line
separated string.
sourceraw docstring

running-repl

source

save-port-file

(save-port-file server options)

Writes a file relative to project classpath with port number so other tools can infer the nREPL server port. Takes nREPL server map and processed CLI options map. Returns nil.

Writes a file relative to project classpath with port number so other tools
can infer the nREPL server port.
Takes nREPL server map and processed CLI options map.
Returns nil.
sourceraw docstring

server-opts

(server-opts options)

Takes a map of nREPL CLI options Returns map of processed options to start an nREPL server.

Takes a map of nREPL CLI options
Returns map of processed options to start an nREPL server.
sourceraw docstring

server-started-message

(server-started-message server options)

Returns nREPL server started message that some tools rely on to parse the connection details from. Takes nREPL server map and processed CLI options map. Returns connection header string.

Returns nREPL server started message that some tools rely on to parse the
connection details from.
Takes nREPL server map and processed CLI options map.
Returns connection header string.
sourceraw docstring

set-signal-handler!macro

(set-signal-handler! signal f)
source

start-server

(start-server {:keys [port bind handler transport greeting],
               :as options})

Creates an nREPL server instance. Takes map of CLI options. Returns nREPL server map.

Creates an nREPL server instance.
Takes map of CLI options.
Returns nREPL server map.
sourceraw docstring

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

× close