github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/README.md (about)

     1  # Murex: A Smarter Shell
     2  
     3  [![Version](version.svg?undef)](DOWNLOAD.md)
     4  [![Murex Tests](https://github.com/lmorg/murex/actions/workflows/murex-tests.yaml/badge.svg)](https://github.com/lmorg/murex/actions/workflows/murex-tests.yaml)
     5  [![Deploy Docs](https://github.com/lmorg/murex/actions/workflows/deploy-docs.yaml/badge.svg)](https://github.com/lmorg/murex/actions/workflows/deploy-docs.yaml)
     6  
     7  <img src="https://murex.rocks/murex-logo-shell.svg?v=undef" class="readme">
     8  
     9  Murex is a shell, like bash / zsh / fish / etc however Murex supports improved
    10  features and an enhanced UX.
    11  
    12  A non-exhaustive list features would include:
    13  
    14  * Support for **additional type information in pipelines**, which can be used
    15    for complex data formats like JSON or tables. Meaning all of your existing
    16    UNIX tools to work more intelligently and without any additional configuration.
    17  
    18  * **Usability improvements** such as in-line spell checking, context sensitive
    19    hint text that details a commands behavior before you hit return, and
    20    auto-parsing man pages for auto-completions on commands that don't have auto-
    21    completions already defined.
    22    
    23  * **Smarter handling of errors** and **debugging tools**. For example try/catch
    24    blocks, line numbers included in error messages, STDOUT highlighted in red
    25    and script testing and debugging frameworks baked into the language itself.
    26  
    27  ## Language Guides
    28  
    29  * Read the [language tour](https://murex.rocks/tour.html) to get started.
    30  
    31  * The [Rosetta Stone](https://murex.rocks/user-guide/rosetta-stone.html) is a
    32  great cheatsheet for those wishing to skip the tutorials and jump straight in.
    33  This guide includes comparisons with Bash.
    34  
    35  * The [Interactive Shell](https://murex.rocks/user-guide/interactive-shell.html)
    36  guide walks you through using Murex as a command line as opposed to a scripting
    37  language.
    38  
    39  ## Examples
    40  
    41  **Smart data:**
    42  
    43  <img src="images/screenshot-open-foreach.png?v=undef" class="readme">
    44  
    45  <img src="images/screenshot-ps-select.png?v=undef" class="readme">
    46  
    47  **Inline spellchecking:**
    48  
    49  <img src="images/screenshot-spellchecker.png?v=undef" class="readme">
    50  
    51  **Autocomplete:**
    52  
    53  <img src="images/screenshot-kill-autocomplete.png?v=undef" class="readme">
    54  
    55  <img src="images/screenshot-autocomplete-git.png?v=undef" class="readme">
    56  
    57  <img src="images/screenshot-history.png?v=undef" class="readme">
    58  
    59  **Preview screen:**
    60  
    61  <img src="images/screenshot-preview-man-page.png?v=undef" class="readme">
    62  
    63  <img src="images/screenshot-preview-custom-hints.png?v=undef" class="readme">
    64  
    65  <img src="images/screenshot-preview-image.png?v=undef" class="readme">
    66  
    67  <img src="images/screenshot-preview-command-line.png?v=undef" class="readme">
    68  
    69  **Useful error messages:**
    70  
    71  <img src="images/screenshot-error-messages.png?v=undef" class="readme">
    72  
    73  <img src="images/screenshot-paste-safety.png?v=undef" class="readme">
    74  
    75  **Plus More!**
    76  
    77  Check out the [Language Tour](https://murex.rocks/tour.html) and [Interactive Shell](https://murex.rocks/user-guide/interactive-shell.html) guides!
    78  
    79  ## Install instructions
    80  
    81  See [INSTALL](https://murex.rocks/INSTALL.html) for details.
    82  
    83  ## Discuss Murex
    84  
    85  Discussions presently happen in [Github discussions](https://github.com/lmorg/murex/discussions).
    86  
    87  ## Compatibility Commitment
    88  
    89  Murex is committed to backwards compatibility. While we do want to continue to
    90  grow and improve the shell, this will not come at the expense of long term
    91  usability. [Read more](compatibility.md)
    92  
    93  ## Known bugs / TODO
    94  
    95  Murex is considered stable, however if you do run into problems then please
    96  raise them on the project's issue tracker: [https://github.com/lmorg/murex/issues](https://github.com/lmorg/murex/issues)
    97  
    98  <hr/>
    99  
   100  This document was generated from [gen/root/README_doc.yaml](https://github.com/lmorg/murex/blob/master/gen/root/README_doc.yaml).