murex rocks

Welcome

About

Install

Change Log

Blog

Technical Docs

Language Tour

Interactive Shell

Rosetta Stone

User Guide

Open Source

Discuss

Contribute

Source Code

Search Site

User Guide

This section contains miscellaneous documents on using and configuring the shell and Murex’s numerous features.

Table of Contents

Language Tour

The Language Tour is a great introduction into the Murex language.

User Guides

• ANSI Constants: Infixed constants that return ANSI escape sequences
• Bang Prefix: Bang prefixing to reverse default actions
• Code Block Parsing: Overview of how code blocks are parsed
• FileRef: How to track what code was loaded and from where
• Hint Text: A status bar for your shell
• Integrations: Default integrations shipped with Murex
• Interactive Shell: What’s different about Murex’s interactive shell?
• Job Control: How to manage jobs with Murex
• Modules And Packages: An introduction to Murex modules and packages
• Named Pipes: A detailed breakdown of named pipes in Murex
• Operators And Tokens: A table of all supported operators and tokens
• Pipeline: Overview of what a “pipeline” is
• Profile Files: A breakdown of the different files loaded on start up
• Reserved Variables: Special variables reserved by Murex
• Rosetta Stone: A tabulated list of Bashism’s and their equivalent Murex syntax
• Schedulers: Overview of the different schedulers (or ‘run modes’) in Murex
• Strict Types In Expressions: Expressions can auto-convert types or strictly honour data types
• Terminal Hotkeys: A list of all the terminal hotkeys and their uses
• Variable and Config Scoping: How scoping works within Murex

Operators And Tokens

• ( expression ): Inline expressions
• C-style functions: Inlined commands for expressions and statements
• "Double Quote": Initiates or terminates a string (variables expanded)
• $Variable Sigil: Expand values as a scalar
• %(Brace Quote): Initiates or terminates a string (variables expanded)
• %[] Array Builder: Quickly generate arrays
• %{} Object Builder: Quickly generate objects (dictionaries / maps)
• && And Logical Operator: Continues next operation if previous operation passes
• 'Single Quote': Initiates or terminates a string (variables not expanded)
• (brace quote): Write a string to the stdout without new line (deprecated)
• *= Multiply By Operator: Multiplies a variable by the right hand value (expression)
• * Multiplication Operator: Multiplies one numeric value with another (expression)
• += Add With Operator: Adds the right hand value to a variable (expression)
• + Addition Operator: Adds two numeric values together (expression)
• -= Subtract By Operator: Subtracts a variable by the right hand value (expression)
• -> Arrow Pipe: Pipes stdout from the left hand command to stdin of the right hand command
• - Subtraction Operator: Subtracts one numeric value from another (expression)
• /= Divide By Operator: Divides a variable by the right hand value (expression)
• / Division Operator: Divides one numeric value from another (expression)
• <~ Assign Or Merge: Merges the right hand value to a variable on the left hand side (expression)
• => Generic Pipe: Pipes a reformatted stdout stream from the left hand command to stdin of the right hand command
• = (arithmetic evaluation): Evaluate a mathematical function (deprecated)
• >> Append File: Writes stdin to disk - appending contents if file already exists
• ?: Elvis Operator: Returns the right operand if the left operand is falsy (expression)
• ?? Null Coalescing Operator: Returns the right operand if the left operand is empty / undefined (expression)
• ? stderr Pipe: Pipes stderr from the left hand command to stdin of the right hand command (DEPRECATED)
• @Array Sigil: Expand values as an array
• [ ..Range ]: Outputs a ranged subset of data from stdin
• [ Index ]: Outputs an element from an array, map or table
• [[ Element ]]: Outputs an element from a nested structure
• [{ Lambda }]: Iterate through structured data
• { Curly Brace }: Initiates or terminates a code block
• |> Truncate File: Writes stdin to disk - overwriting contents if file already exists
• | POSIX Pipe: Pipes stdout from the left hand command to stdin of the right hand command
• || Or Logical Operator: Continues next operation only if previous operation fails
• ~ Home Sigil: Home directory path variable

Builtin Commands

Standard Builtins

• ! (not): Reads the stdin and exit number from previous process and not’s it’s condition
• 2darray: Create a 2D JSON array from multiple input sources
• <pipe> Read Named Pipe: Reads from a Murex named pipe
• <stdin>: Read the stdin belonging to the parent code block
• @g (autoglob): Command prefix to expand globbing (deprecated)
• a (mkarray): A sophisticated yet simple way to build an array or list
• addheading: Adds headings to a table
• alias: Create an alias for a command
• alter: Change a value within a structured data-type and pass that change along the pipeline without altering the original source input
• and: Returns true or false depending on whether multiple conditions are met
• append: Add data to the end of an array
• args: Command line flag parser for Murex shell scripting
• autocomplete: Set definitions for tab-completion in the command line
• bexists: Check which builtins exist
• bg: Run processes in the background
• break: Terminate execution of a block within your processes scope
• cast: Alters the data-type of the previous function without altering its output
• catch: Handles the exception code raised by try or trypipe
• cd: Change (working) directory
• config: Query or define Murex runtime settings
• continue: Terminate process of a block within a caller function
• count: Count items in a map, list or array
• cpuarch: Output the hosts CPU architecture
• cpucount: Output the number of CPU cores available on your host
• datetime: A date and/or time conversion tool (like printf but for date and time values)
• debug: Debugging information
• die: Terminate murex with an exit number of 1
• err: Print a line to the stderr
• escape: Escape or unescape input
• esccli: Escapes an array so output is valid shell code
• eschtml: Encode or decodes text for HTML
• escurl: Encode or decodes text for the URL
• event: Event driven programming for shell scripts
• exec: Runs an executable
• exit: Exit murex
• exitnum: Output the exit number of the previous process
• export: Define an environmental variable and set it’s value
• expr: Expressions: mathematical, string comparisons, logical operators
• f: Lists or filters file system objects (eg files)
• false: Returns a false value
• fexec: Execute a command or function, bypassing the usual order of precedence.
• fg: Sends a background process into the foreground
• fid-kill: Terminate a running Murex function
• fid-killall: Terminate all running Murex functions
• fid-list: Lists all running functions within the current Murex session
• for: A more familiar iteration loop to existing developers
• foreach: Iterate through an array
• formap: Iterate through a map or other collection of data
• format: Reformat one data-type into another data-type
• function: Define a function block
• g: Glob pattern matching for file system objects (eg *.txt)
• get-type: Returns the data-type of a variable or pipe
• get: Makes a standard HTTP request and returns the result as a JSON object
• getfile: Makes a standard HTTP request and return the contents as Murex-aware data type for passing along Murex pipelines.
• global: Define a global variable and set it’s value
• history: Outputs murex’s command history
• if: Conditional statement to execute different blocks of code depending on the result of the condition
• is-null: Checks if a variable is null or undefined
• ja (mkarray): A sophisticated yet simply way to build a JSON array
• jsplit: Splits stdin into a JSON array based on a regex parameter
• key-code: Returns character sequences for any key pressed (ie sent from the terminal)
• left: Left substring every item in a list
• let: Evaluate a mathematical function and assign to variable (deprecated)
• lockfile: Create and manage lock files
• man-get-flags: Parses man page files for command line flags
• man-summary: Outputs a man page summary of a command
• map: Creates a map from two data sources
• match: Match an exact value in an array
• method: Define a methods supported data-types
• msort: Sorts an array - data type agnostic
• mtac: Reverse the order of an array
• murex-docs: Displays the man pages for Murex builtins
• murex-package: Murex’s package manager
• murex-parser: Runs the Murex parser against a block of code
• murex-update-exe-list: Forces Murex to rescan $PATH looking for executables
• null: null function. Similar to /dev/null
• open-image: Renders bitmap image data on your terminal
• open: Open a file with a preferred handler
• openagent: Creates a handler function for open
• or: Returns true or false depending on whether one code-block out of multiple ones supplied is successful or unsuccessful.
• os: Output the auto-detected OS name
• out: Print a string to the stdout with a trailing new line character
• pipe: Manage Murex named pipes
• post: HTTP POST request with a JSON-parsable return
• prefix: Prefix a string to every item in a list
• prepend: Add data to the start of an array
• pretty: Prettifies JSON to make it human readable
• private: Define a private function block
• pt: Pipe telemetry. Writes data-types and bytes written
• rand: Random field generator
• read: read a line of input from the user and store as a variable
• regexp: Regexp tools for arrays / lists of strings
• return: Exits current function scope
• right: Right substring every item in a list
• round: Round a number by a user defined precision
• runmode: Alter the scheduler’s behaviour at higher scoping level
• runtime: Returns runtime information on the internal state of Murex
• rx: Regexp pattern matching for file system objects (eg .*\\.txt)
• set: Define a local variable and set it’s value
• signal: Sends a signal RPC
• source: Import Murex code from another file of code block
• struct-keys: Outputs all the keys in a structure as a file path
• suffix: Prefix a string to every item in a list
• summary: Defines a summary help text for a command
• switch: Blocks of cascading conditionals
• ta (mkarray): A sophisticated yet simple way to build an array of a user defined data-type
• tabulate: Table transformation tools
• test: Murex’s test framework - define tests, run tests and debug shell scripts
• time: Returns the execution run time of a command or block
• tmp: Create a temporary file and write to it
• tout: Print a string to the stdout and set it’s data-type
• tread: read a line of input from the user and store as a user defined typed variable (deprecated)
• true: Returns a true value
• try: Handles non-zero exits inside a block of code
• tryerr: Handles errors inside a block of code
• trypipe: Checks for non-zero exits of each function in a pipeline
• trypipeerr: Checks state of each function in a pipeline and exits block on error
• type: Command type (function, builtin, alias, etc)
• unsafe: Execute a block of code, always returning a zero exit number
• version: Get Murex version
• which: Locate command origin
• while: Loop until condition false

Optional Builtins

These builtins are optional. select is included as part of the default build but can be disabled without breaking functionality. The other optional builtins are only included by default on Windows.

• !bz2: Decompress a bz2 file
• base64: Encode or decode a base64 string
• gz: Compress or decompress a gzip file
• qr: Creates a QR code from stdin
• select: Inlining SQL into shell pipelines
• sleep: Suspends the shell for a number of seconds

Data Types

• * (generic): generic (primitive)
• bool: Boolean (primitive)
• commonlog: Apache httpd “common” log format
• csv: CSV files (and other character delimited tables)
• float (floating point number): Floating point number (primitive)
• hcl: HashiCorp Configuration Language (HCL)
• int: Whole number (primitive)
• json: JavaScript Object Notation (JSON)
• jsonc: Concatenated JSON
• jsonl: JSON Lines
• num (number): Floating point number (primitive)
• path: Structured object for working with file and directory paths
• paths: Structured array for working with $PATH style data
• str (string): string (primitive)
• toml: Tom’s Obvious, Minimal Language (TOML)
• yaml: YAML Ain’t Markup Language (YAML)
• mxjson: Murex-flavoured JSON (deprecated)

Events

• onCommandCompletion: Trigger an event upon a command’s completion
• onFileSystemChange: Add a filesystem watch
• onKeyPress: Custom definable key bindings and macros
• onPreview: Full screen previews for files and command documentation
• onPrompt: Events triggered by changes in state of the interactive shell
• onSecondsElapsed: Events triggered by time intervals
• onSignalReceived: Trap OS signals

Integrations

• ChatGPT: How to enable ChatGPT hints
• Cheat.sh: Cheatsheets provided by cheat.sh
• Kitty Integrations: Get more out of Kitty terminal emulator
• Makefiles / make: make integrations
• Man Pages (POSIX): Linux/UNIX man page integrations
• Spellcheck: How to enable inline spellchecking
• Terminology Integrations: Get more out of Terminology terminal emulator
• direnv Integrations: Directory specific environmental variables
• yarn Integrations: Working with yarn and package.json
• iTerm2 Integrations: Get more out of iTerm2 terminal emulator

API Reference

These API docs are provided for any developers wishing to write their own builtins.

• Marshal() (type): Converts structured memory into a structured file format (eg for stdio)
• ReadArray() (type): Read from a data type one array element at a time
• ReadArrayWithType() (type): Read from a data type one array element at a time and return the elements contents and data type
• ReadIndex() (type): Data type handler for the index, [, builtin
• ReadMap() (type): Treat data type as a key/value structure and read its contents
• ReadNotIndex() (type): Data type handler for the bang-prefixed index, ![, builtin
• Unmarshal() (type): Converts a structured file format into structured memory
• WriteArray() (type): Write a data type, one array element at a time
• lang.ArrayTemplate() (template API): Unmarshals a data type into a Go struct and returns the results as an array
• lang.ArrayWithTypeTemplate() (template API): Unmarshals a data type into a Go struct and returns the results as an array with data type included
• lang.IndexTemplateObject() (template API): Returns element(s) from a data structure
• lang.IndexTemplateTable() (template API): Returns element(s) from a table
• lang.MarshalData() (system API): Converts structured memory into a Murex data-type (eg for stdio)
• lang.UnmarshalData() (system API): Converts a Murex data-type into structured memory