{"repo":"OceanSprint/tesh","free":true,"listed":false,"github":"https://github.com/OceanSprint/tesh","clone":"git clone https://github.com/OceanSprint/tesh.git","description":"TEstable SHell sessions in Markdown","language":"Python","stars":145,"topics":["markdown","shell","testing"],"license":"MIT","category":"cli-tools","readme_excerpt":"tesh [[tɛʃ]](http://ipa-reader.xyz/?text=t%C9%9B%CA%83&voice=Joanna) - TEstable SHell sessions in Markdown Showing shell interactions how to run a tool is useful for teaching and explaining. Making sure that example still works over the years is painfully hard. Not anymore. Syntax To mark a code block as testable, append tesh-session=\"NAME\" to the header line. You can use any syntax highlighting directive, such as bash , shell , shell-session , console or others. Linking multiple code blocks into a single shell session Besides marking a code block as testable, tesh-session is a unique identifier that allows for multiple code blocks to share the same session. Ignoring parts of the output Parts of the inline output can be ignored with ... : Multiline support The same can be done for multiple lines of output. Note that trailing whitespace in every line is trimmed. Commands can continue across multiple lines by prefixing lines with . Advanced directives You can set a few other optional directives in the header line: - tesh-exitcodes : a list of exit codes in the order of commands executed inside the code block, - tesh-setup : a filename of a script to run before running the commands in the code block, - tesh-ps1 : allow an additional PS1 prompt besides the default $ , - tesh-platform : specify on which platforms this session block should be tested ( linux , darwin , windows ), - tesh-fixture : a filename to save the current snippet, - tesh-timeout : number of seconds before a com","default_branch":null,"files":null,"tree":[],"storefront":"/r/OceanSprint","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/OceanSprint/tesh/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}