1 | ---
|
2 | title: YSH Table of Contents
|
3 | all_docs_url: ..
|
4 | css_files: ../../web/base.css ../../web/manual.css ../../web/ref-index.css
|
5 | preserve_anchor_case: yes
|
6 | ---
|
7 |
|
8 | <div class="doc-ref-header">
|
9 |
|
10 | [Oils Reference](index.html) —
|
11 | [OSH](toc-osh.html) | **YSH Table of Contents** | [Data Notation](toc-data.html)
|
12 |
|
13 | </div>
|
14 |
|
15 | [YSH]($xref) is shell with a familiar syntax, JSON-like data structures, good
|
16 | error handling, and more.
|
17 |
|
18 | <!--
|
19 | <div class="custom-toc">
|
20 |
|
21 | [type-method](#type-method)
|
22 | [builtin-func](#builtin-func)
|
23 | [builtin-cmd](#builtin-cmd)
|
24 | [front-end](#front-end)
|
25 | [cmd-lang](#cmd-lang)
|
26 | [ysh-cmd](#ysh-cmd)
|
27 | [expr-lang](#expr-lang)
|
28 | [word-lang](#word-lang)
|
29 | [mini-lang](#mini-lang)
|
30 | [option](#option)
|
31 | [special-var](#special-var)
|
32 | [plugin](#plugin)
|
33 |
|
34 | </div>
|
35 | -->
|
36 |
|
37 | <h2 id="type-method">
|
38 | Types and Methods <a class="group-link" href="chap-type-method.html">type-method</a>
|
39 | </h2>
|
40 |
|
41 | ```chapter-links-type-method
|
42 | [Atom Types] Null Bool
|
43 | [Number Types] Int Float
|
44 | [Str] X find() replace()
|
45 | trim() trimStart() trimEnd()
|
46 | startsWith() endsWith()
|
47 | upper() lower()
|
48 | search() leftMatch()
|
49 | [List] List/append() pop() extend() indexOf()
|
50 | X insert() X remove() reverse()
|
51 | [Dict] keys() values() X get() X erase()
|
52 | X inc() X accum()
|
53 | [Range]
|
54 | [Eggex]
|
55 | [Match] group() start() end()
|
56 | X groups() X groupDict()
|
57 | [Place] setValue()
|
58 | [Code Types] Expr Command
|
59 | BuiltinFunc BoundFunc
|
60 | X [Func] name() location() toJson()
|
61 | X [Proc] name() location() toJson()
|
62 | X [Module] name() filename()
|
63 | [IO] X eval() X captureStdout()
|
64 | promptVal()
|
65 | X time() X strftime()
|
66 | X glob()
|
67 | X [Guts] heapId()
|
68 | ```
|
69 |
|
70 | <h2 id="builtin-func">
|
71 | Builtin Functions <a class="group-link" href="chap-builtin-func.html">builtin-func</a>
|
72 | </h2>
|
73 |
|
74 | ```chapter-links-builtin-func
|
75 | [Values] len() func/type() X repeat()
|
76 | [Conversions] bool() int() float() str() list() dict()
|
77 | X runes() X encodeRunes()
|
78 | X bytes() X encodeBytes()
|
79 | [Str] X strcmp() X split() shSplit()
|
80 | [List] join() any() all()
|
81 | [Collections] X copy() X deepCopy()
|
82 | [Word] glob() maybe()
|
83 | [Math] abs() max() min() X round() sum()
|
84 | [Serialize] toJson() fromJson()
|
85 | toJson8() fromJson8()
|
86 | X [J8 Decode] J8.Bool() J8.Int() ...
|
87 | [Pattern] _group() _start() _end()
|
88 | [Introspection] shvarGet() getVar() evalExpr()
|
89 | [Hay Config] parseHay() evalHay()
|
90 | X [Hashing] sha1dc() sha256()
|
91 | ```
|
92 |
|
93 | <!-- ideas
|
94 | X [Codecs] quoteUrl() quoteHtml() quoteSh() quoteC()
|
95 | quoteMake() quoteNinja()
|
96 | X [Wok] _field()
|
97 | -->
|
98 |
|
99 | <h2 id="builtin-cmd">
|
100 | Builtin Commands <a class="group-link" href="chap-builtin-cmd.html">builtin-cmd</a>
|
101 | </h2>
|
102 |
|
103 | <!-- linkify_stop_col is 42 -->
|
104 |
|
105 | ```chapter-links-builtin-cmd_42
|
106 | [Memory] cmd/append Add elements to end of array
|
107 | pp asdl cell X gc-stats line proc
|
108 | [Handle Errors] error error 'failed' (status=2)
|
109 | try Run with errexit, set _error
|
110 | failed Test if _error.code !== 0
|
111 | boolstatus Enforce 0 or 1 exit status
|
112 | [Shell State] ysh-cd ysh-shopt compatible, and takes a block
|
113 | shvar Temporary modify global settings
|
114 | ctx Share and update a temporary "context"
|
115 | push-registers Save registers like $?, PIPESTATUS
|
116 | [Modules] runproc Run a proc; use as main entry point
|
117 | module guard against duplicate 'source'
|
118 | is-main false when sourcing a file
|
119 | use change first word lookup
|
120 | [I/O] ysh-read flags --all, -0
|
121 | ysh-echo no -e -n with simple_echo
|
122 | write Like echo, with --, --sep, --end
|
123 | fork forkwait Replace & and (), and takes a block
|
124 | fopen Open multiple streams, takes a block
|
125 | X dbg Only thing that can be used in funcs
|
126 | X log X die Common functions (polyfill)
|
127 | [Hay Config] hay haynode For DSLs and config files
|
128 | [Completion] compadjust compexport
|
129 | [Data Formats] json read write
|
130 | json8 read write
|
131 | X [TSV8] rows pick rows; dplyr filter()
|
132 | cols pick columns ('select' already taken)
|
133 | group-by add a column with a group ID [ext]
|
134 | sort-by sort by columns; dplyr arrange() [ext]
|
135 | summary count, sum, histogram, etc. [ext]
|
136 | [Args Parser] parser Parse command line arguments
|
137 | flag
|
138 | arg
|
139 | rest
|
140 | parseArgs()
|
141 | X [Testing] describe Test harness
|
142 | assert takes an expression
|
143 | ```
|
144 |
|
145 | <!--
|
146 | Naming ideas:
|
147 |
|
148 | X [External Lang] BEGIN END when (awk)
|
149 | rule (make) each (xargs) fs (find)
|
150 | -->
|
151 |
|
152 | <h2 id="front-end">
|
153 | Front End <a class="group-link" href="chap-front-end.html">front-end</a>
|
154 | </h2>
|
155 |
|
156 | ```chapter-links-front-end
|
157 | [Usage] oils-usage ysh-usage
|
158 | [Lexing] ascii-whitespace [ \t\r\n]
|
159 | doc-comment ### multiline-command ...
|
160 | [Tools] cat-em
|
161 | ```
|
162 |
|
163 | <h2 id="cmd-lang">
|
164 | Command Language <a class="group-link" href="chap-cmd-lang.html">cmd-lang</a>
|
165 | </h2>
|
166 |
|
167 | <!-- linkify_stop_col is 33 -->
|
168 |
|
169 | ```chapter-links-cmd-lang_33
|
170 | [YSH Simple] typed-arg json write (x)
|
171 | lazy-expr-arg assert [42 === x]
|
172 | block-arg cd /tmp { echo $PWD }; cd /tmp (; ; blockexpr)
|
173 | [YSH Cond] ysh-case case (x) { *.py { echo 'python' } }
|
174 | ysh-if if (x > 0) { echo }
|
175 | [YSH Iter] ysh-while while (x > 0) { echo }
|
176 | ysh-for for i, item in (mylist) { echo }
|
177 | ```
|
178 |
|
179 | <h2 id="ysh-cmd">
|
180 | YSH Command Language Keywords <a class="group-link" href="chap-ysh-cmd.html">ysh-cmd</a>
|
181 | </h2>
|
182 |
|
183 | ```chapter-links-ysh-cmd_33
|
184 | [Assignment] const var Declare variables
|
185 | setvar setvar a[i] = 42
|
186 | setglobal setglobal d.key = 'foo'
|
187 | [Expression] equal = = 1 + 2*3
|
188 | call call mylist->append(42)
|
189 | [Definitions] proc proc p (s, ...rest) {
|
190 | typed proc p (; typed, ...rest; n=0; b) {
|
191 | func func f(x; opt1, opt2) { return (x + 1) }
|
192 | ysh-return return (myexpr)
|
193 | ```
|
194 |
|
195 | <h2 id="expr-lang">
|
196 | Expression Language and Assignments <a class="group-link" href="chap-expr-lang.html">expr-lang</a>
|
197 | </h2>
|
198 |
|
199 | <!-- linkify_stop_col is 33 -->
|
200 |
|
201 | ```chapter-links-expr-lang_33
|
202 | [Assignment] assign =
|
203 | aug-assign += -= *= /= **= //= %=
|
204 | &= |= ^= <<= >>=
|
205 | [Literals] atom-literal true false null
|
206 | int-literal 42 65_536 0xFF 0o755 0b10
|
207 | float-lit 3.14 1.5e-10
|
208 | X num-suffix 42 K Ki M Mi G Gi T Ti / ms us
|
209 | ysh-string "x is $x" $"x is $x" r'[a-z]\n'
|
210 | u'line\n' b'byte \yff'
|
211 | triple-quoted """ $""" r''' u''' b'''
|
212 | str-template ^"$a and $b" for Str::replace()
|
213 | list-literal ['one', 'two', 3] :| unquoted words |
|
214 | dict-literal {name: 'bob'} {a, b}
|
215 | range 1 .. n+1
|
216 | block-expr ^(echo $PWD)
|
217 | expr-literal ^[1 + 2*3]
|
218 | X expr-sub $[myobj]
|
219 | X expr-splice @[myobj]
|
220 | [Operators] op-precedence Like Python
|
221 | concat s1 ++ s2, L1 ++ L2
|
222 | ysh-equals === !== ~== is, is not
|
223 | ysh-in in, not in
|
224 | ysh-compare < <= > >= (numbers only)
|
225 | ysh-logical not and or
|
226 | ysh-arith + - * / // % **
|
227 | ysh-bitwise ~ & | ^ << >>
|
228 | ysh-ternary '+' if x >= 0 else '-'
|
229 | ysh-index s[0] mylist[3] mydict['key']
|
230 | ysh-attr mydict.key
|
231 | ysh-slice a[1:-1] s[1:-1]
|
232 | func-call f(x, y; ...named)
|
233 | thin-arrow mylist->pop()
|
234 | fat-arrow mystr => startsWith('prefix')
|
235 | match-ops ~ !~ ~~ !~~
|
236 | [Eggex] re-literal / d+ ; re-flags ; ERE /
|
237 | re-primitive %zero 'sq'
|
238 | class-literal [c a-z 'abc' @str_var \\ \xFF \u0100]
|
239 | named-class dot digit space word d s w
|
240 | re-repeat d? d* d+ d{3} d{2,4}
|
241 | re-compound seq1 seq2 alt1|alt2 (expr1 expr2)
|
242 | re-capture <capture d+ as name: int>
|
243 | re-splice Subpattern @subpattern
|
244 | re-flags reg_icase reg_newline
|
245 | X re-multiline ///
|
246 | ```
|
247 |
|
248 | <h2 id="word-lang">
|
249 | Word Language <a class="group-link" href="chap-word-lang.html">word-lang</a>
|
250 | </h2>
|
251 |
|
252 | <!-- linkify_stop_col is 33 -->
|
253 |
|
254 | ```chapter-links-word-lang_33
|
255 | [Quotes] ysh-string "x is $x" $"x is $x" r'[a-z]\n'
|
256 | u'line\n' b'byte \yff'
|
257 | triple-quoted """ $""" r''' u''' b'''
|
258 | X tagged-str "<span id=$x>"html
|
259 | [Substitutions] expr-sub echo $[42 + a[i]]
|
260 | expr-splice echo @[split(x)]
|
261 | var-splice @myarray @ARGV
|
262 | command-sub @(split command)
|
263 | [Formatting] X ysh-printf ${x %.3f}
|
264 | X ysh-format ${x|html}
|
265 | ```
|
266 |
|
267 | <h2 id="mini-lang">
|
268 | Other Mini Languages <a class="group-link" href="chap-mini-lang.html">mini-lang</a>
|
269 | </h2>
|
270 |
|
271 | <!-- linkify_stop_col is 33 -->
|
272 |
|
273 | ```chapter-links-mini-lang_33
|
274 | [Patterns] glob-pat *.py
|
275 | [Other Sublang] braces {alice,bob}@example.com
|
276 | ```
|
277 |
|
278 | <h2 id="option">
|
279 | Global Shell Options <a class="group-link" href="chap-option.html">option</a>
|
280 | </h2>
|
281 |
|
282 | ```chapter-links-option
|
283 | [Groups] strict:all ysh:upgrade ysh:all
|
284 | [YSH Details] opts-redefine opts-internal
|
285 | ```
|
286 |
|
287 | <h2 id="special-var">
|
288 | Special Variables <a class="group-link" href="chap-special-var.html">special-var</a>
|
289 | </h2>
|
290 |
|
291 | ```chapter-links-special-var
|
292 | [YSH Vars] ARGV X ENV X _ESCAPE
|
293 | _this_dir
|
294 | [YSH Status] _error
|
295 | _pipeline_status _process_sub_status
|
296 | [YSH Tracing] SHX_indent SHX_punct SHX_pid_str
|
297 | [YSH read] _reply
|
298 | [History] YSH_HISTFILE
|
299 | [Oils VM] OILS_VERSION
|
300 | OILS_GC_THRESHOLD OILS_GC_ON_EXIT
|
301 | OILS_GC_STATS OILS_GC_STATS_FD
|
302 | ```
|
303 |
|
304 | <!-- ideas
|
305 | X [Wok] _filename _line _line_num
|
306 | X [Builtin Sub] _buffer
|
307 | -->
|
308 |
|
309 | <h2 id="plugin">
|
310 | Plugins and Hooks <a class="group-link" href="chap-plugin.html">plugin</a>
|
311 | </h2>
|
312 |
|
313 | ```chapter-links-plugin
|
314 | [YSH] renderPrompt()
|
315 | ```
|