You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -32,6 +35,7 @@ Run `gum <cmd> --help` to discover all the params and args.
32
35
This lib only has _one_ public fn: `bblgum.core/gum`.
33
36
34
37
## Standard Usage
38
+
35
39
`gum` tries to closely mimic the usage of the CLI tool, so it works like `(gum :COMMAND)`,
36
40
`(gum :COMMAND [ARGS])` or `(gum :COMMAND [ARGS] :OPTION VALUE :OPTION2 VALUE)`
37
41
@@ -40,6 +44,7 @@ This lib only has _one_ public fn: `bblgum.core/gum`.
40
44
```
41
45
42
46
Examples:
47
+
43
48
```clojure
44
49
;; Command only:
45
50
(b/gum:file)
@@ -66,25 +71,29 @@ To pass flags like `--directory` use `:directory true`. **Always use full names
66
71
**Note**: In the event of a name collision with a special opt and a command opt, use the [low level API](https://github.com/lispyclouds/bblgum#low-level-api).
@@ -132,14 +141,16 @@ All of the rest of the options and usecases _should work_ ™. Please raise issu
132
141
133
142
- Since this uses gum which expects an interactive TTY like terminal, this is not possible to be used from editor REPLs like Conjure, CIDER, Calva etc **when jacked-in**.
134
143
To use this from an editor REPL:
135
-
- First start the REPL in a terminal, for example in bb for nREPL on port 1667: `bb nrepl-server 1667`.
136
-
- Connect to the port from the editor of your choice, for example with neovim and conjure: `:ConjureConnect 1667`.
137
-
- Perform the usual REPL interactions and all the gum output would appear on the terminal and not your editor but the result should be on the editor as expected.
144
+
- First start the REPL in a terminal, for example in bb for nREPL on port 1667: `bb nrepl-server 1667`.
145
+
- Connect to the port from the editor of your choice, for example with neovim and conjure: `:ConjureConnect 1667`.
146
+
- Perform the usual REPL interactions and all the gum output would appear on the terminal and not your editor but the result should be on the editor as expected.
138
147
139
148
## Low-level API
149
+
140
150
This was standard in previous versions of gum, we kept it for full backward compatibility.
141
151
142
152
Convention:
153
+
143
154
- The main command should be passed as a keyword or string to `:cmd`. Required
144
155
- Passing opts:
145
156
- The --opts are to be passed as `:opts`
@@ -159,7 +170,6 @@ Convention:
159
170
The `gum` fn returns a map of exit status of calling gum and the result either as a seq of lines or coerced via `:as`.
160
171
Exceptions are not thrown unless calling gum itself does, the status code is intended for programming for failures.
161
172
162
-
163
173
```clojure
164
174
(b/gum {:cmd:choose
165
175
:opts {:no-limittrue}
@@ -168,7 +178,6 @@ Exceptions are not thrown unless calling gum itself does, the status code is int
0 commit comments