mq

https://mqlang.org/book/
Admin
mq is a command-line tool for processing Markdown using jq-like syntax, written in Rust for slicing,...
Tokens:65,506
Snippets:580
Trust Score:5.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### mq CLI Examples: Filtering and REPL

Source: https://mqlang.org/book/reference/cli

This snippet provides practical examples of using the mq command-line tool. It demonstrates how to filter markdown nodes with a query, read a query from a file, start an interactive REPL session, and format mq files.

```bash
# Examples:

## To filter markdown nodes:
mq 'query' file.md

## To read query from file:
mq -f 'file' file.md

## To start a REPL session:
mq repl

## To format mq file:
mq fmt --check file.mq
```

--------------------------------

### MQ CLI Examples

Source: https://mqlang.org/book/print

Illustrates common use cases for the mq CLI, such as filtering markdown nodes, loading queries from files, starting a REPL session, and formatting mq files.

```bash
# To filter markdown nodes:
mq 'query' file.md

# To read query from file:
mq -f 'file' file.md

# To start a REPL session:
mq repl

# To format mq file:
mq fmt --check file.mq
```

--------------------------------

### Install mq with Debugger (Shell)

Source: https://mqlang.org/book/start/debugger

Installs the mq debugger-enabled version using a curl script. This is a convenient way to get the debugger set up.

```shell
curl -sSL https://mqlang.org/install.sh | bash -s -- --with-debug
```

--------------------------------

### Install mq Language Server using install script

Source: https://mqlang.org/book/start/install

Installs the mq Language Server, which provides IDE features like completion, hover, and diagnostics for mq query files. This script downloads and installs the LSP.

```bash
curl -sSL https://mqlang.org/install_lsp.sh | bash
```

--------------------------------

### Install mq-tui

Source: https://mqlang.org/book/start/tui

Installs the mq-tui tool by downloading and executing an installation script from GitHub. This is the primary method for setting up the tool on your system.

```bash
curl -fsSL https://raw.githubusercontent.com/harehare/mq-tui/main/bin/install.sh | bash
```

--------------------------------

### Install mq CLI using install script

Source: https://mqlang.org/book/start/install

Installs the latest mq binary for your platform to ~/.mq/bin/ and updates your shell profile. It can also install the debugger by passing the --with-debug flag.

```bash
curl -sSL https://mqlang.org/install.sh | bash
# Install the debugger
curl -sSL https://mqlang.org/install.sh | bash -s -- --with-debug
```

--------------------------------

### mq Examples

Source: https://mqlang.org/book/reference/cli

Illustrative examples of how to use the mq CLI for common tasks.

```APIDOC
## mq Examples

### Description
Provides practical examples for using the mq command-line tool.

### Examples

#### To filter markdown nodes:
```bash
mq 'query' file.md
```

#### To read query from file:
```bash
mq -f 'file' file.md
```

#### To start a REPL session:
```bash
mq repl
```

#### To format mq file:
```bash
mq fmt --check file.mq
```

### Response
N/A
```

--------------------------------

### Install mq Language Server using cargo

Source: https://mqlang.org/book/start/install

Installs the mq Language Server from crates.io or GitHub. It supports installing specific versions, the latest development version, and can be installed using binstall.

```bash
# Install from crates.io
car go install mq-lsp
# Install from Github
car go install --git https://github.com/harehare/mq.git mq-lsp --tag v0.5.16
# Latest Development Version
car go install --git https://github.com/harehare/mq.git mq-lsp
# Install using binstall
car go binstall mq-lsp@0.5.16
```

--------------------------------

### Install Development Dependencies

Source: https://mqlang.org/book/start/development

Installs necessary development dependencies for the MQ project. Supports installation via cargo or asdf.

```bash
# Using cargo
carog install just wasm-pack
```

```bash
# Using asdf
asdf install
```

--------------------------------

### Install mq Language Server using pre-built binaries

Source: https://mqlang.org/book/start/install

Downloads and installs mq Language Server binaries for various platforms (macOS, Linux, Windows) from GitHub releases. Ensure the downloaded binary is executable.

```bash
# macOS (Apple Silicon)
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-lsp-aarch64-apple-darwin -o /usr/local/bin/mq-lsp && chmod +x /usr/local/bin/mq-lsp
# Linux x86_64
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-lsp-x86_64-unknown-linux-gnu -o /usr/local/bin/mq-lsp && chmod +x /usr/local/bin/mq-lsp
# Linux arm64
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-lsp-aarch64-unknown-linux-gnu -o /usr/local/bin/mq-lsp && chmod +x /usr/local/bin/mq-lsp
# Windows (PowerShell)
Invoke-WebRequest -Uri https://github.com/harehare/mq/releases/download/v0.5.16/mq-lsp-x86_64-pc-windows-msvc.exe -OutFile "$env:USERPROFILE\bin\mq-lsp.exe"
```

--------------------------------

### Install mq CLI using pre-built binaries

Source: https://mqlang.org/book/start/install

Downloads and installs mq CLI binaries for various platforms (macOS, Linux, Windows) by fetching them from GitHub releases. Ensure the downloaded binary is executable.

```bash
# macOS (Apple Silicon)
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-aarch64-apple-darwin -o /usr/local/bin/mq && chmod +x /usr/local/bin/mq
# Linux x86_64
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-x86_64-unknown-linux-gnu -o /usr/local/bin/mq && chmod +x /usr/local/bin/mq
# Linux arm64
curl -L https://github.com/harehare/mq/releases/download/v0.5.16/mq-aarch64-unknown-linux-gnu -o /usr/local/bin/mq && chmod +x /usr/local/bin/mq
# Windows (PowerShell)
Invoke-WebRequest -Uri https://github.com/harehare/mq/releases/download/v0.5.16/mq-x86_64-pc-windows-msvc.exe -OutFile "$env:USERPROFILE\bin\mq.exe"
```

--------------------------------

### mqcr Example Commands

Source: https://mqlang.org/book/start/crawler

Provides practical examples of how to use the mqcr command-line tool for different scenarios, such as basic crawling, saving to a directory with a custom delay, and processing with an mq-lang query.

```bash
# Basic crawling to stdout
mqcr https://example.com

# Save to directory with custom delay
mqcr -o ./output -c 2 https://example.com

# Process with mq-lang query
mqcr -m '.h | select(contains("News"))' https://example.com
```

--------------------------------

### Install mqcr with Homebrew

Source: https://mqlang.org/book/start/crawler

Installs the mqcr binary on macOS and Linux using the Homebrew package manager. This is the recommended installation method for ease of use and updates.

```bash
brew install harehare/tap/mqcr
```

--------------------------------

### Install mqcr using Homebrew

Source: https://mqlang.org/book/start/install

Installs the 'mqcr' tool on macOS and Linux systems using the Homebrew package manager from the 'harehare/tap' repository.

```bash
# Using Homebrew (macOS and Linux)
$ brew install harehare/tap/mqcr
```

--------------------------------

### MQLang Doc-Comment Example

Source: https://mqlang.org/book/reference/comments

This snippet demonstrates a doc-comment in MQLang, which is similar to comments in jq. Comments starting with '#' are treated as doc-comments. This example shows a simple function call 'add(2, 3)' within a doc-comment.

```mqlang
# doc-comment
let value = add(2, 3);

```

--------------------------------

### Install mq CLI using Homebrew

Source: https://mqlang.org/book/start/install

Installs the mq CLI tool on macOS and Linux systems using the Homebrew package manager.

```bash
# Using Homebrew (macOS and Linux)
$ brew install mq
```

--------------------------------

### Install mq CLI using cargo

Source: https://mqlang.org/book/start/install

Installs the mq CLI tool from crates.io or GitHub. It supports installing specific versions, the latest development version, and the debugger with the 'debugger' feature.

```bash
# Install from crates.io
car go install mq-run
# Install from Github
car go install --git https://github.com/harehare/mq.git mq-run --tag v0.5.16
# Latest Development Version
car go install --git https://github.com/harehare/mq.git mq-run --bin mq
# Install the debugger
car go install --git https://github.com/harehare/mq.git mq-run --bin mq-dbg --features="debugger"
# Install using binstall
car go binstall mq-run@0.5.16
```

--------------------------------

### Install mq Debugger from Source (Cargo)

Source: https://mqlang.org/book/start/debugger

Builds and installs the mq debugger from its Git repository using Cargo. This method ensures you have the latest version directly from the source.

```shell
cargo install --git https://github.com/harehare/mq.git mq-run --bin mq-dbg
```

--------------------------------

### Create and view a sample mq file with syntax highlighting

Source: https://mqlang.org/book/print

Creates a sample 'example.mq' file and then displays it using 'bat' to showcase mq syntax highlighting. This is a practical example of the previous configuration steps.

```bash
cat > example.mq << 'EOF'
# This is a comment
def greet(name):
  s"Hello, ${name}!"
end

.h | .text | greet("World")
EOF

bat example.mq
```

--------------------------------

### Get URLs from Markdown Links

Source: https://mqlang.org/book/start/example

This query extracts all URLs from Markdown link syntax. It's useful for collecting all external or internal links present in a document.

```mq
__
.link.url
```

--------------------------------

### Install mq Debugger with Homebrew (Shell)

Source: https://mqlang.org/book/start/debugger

Installs the mq debugger-enabled version using Homebrew. This is a straightforward method for macOS and Linux users who manage packages with Homebrew.

```shell
brew install harehare/tap/mq-dbg
```

--------------------------------

### Process Large Numbers of Files Efficiently

Source: https://mqlang.org/book/start/example

This MQLang command-line example shows how to process a large number of files efficiently using the `-P` flag for parallel processing. It specifies the number of parallel workers (e.g., 5) and the query to apply to each file (e.g., selecting `.h1` elements).

```Shell
$ mq -P 5 '.h1' docs/**/*.md
```

--------------------------------

### Install mq npm package

Source: https://mqlang.org/book/start/install

Installs the 'mq-web' npm package, enabling the use of mq functionality within Node.js projects and web applications. This is done using npm.

```bash
$ npm i mq-web
```

--------------------------------

### Install mq Python package

Source: https://mqlang.org/book/start/install

Installs the 'markdown-query' Python package, which provides mq functionality for use in Python applications. This is done using pip.

```bash
# Install from PyPI
$ pip install markdown-query
```

--------------------------------

### MQLang Anonymous Function Default Parameter Examples

Source: https://mqlang.org/book/reference/fn

Provides examples of anonymous functions with default parameters in MQLang. Shows how to define, use, and override default values, including within callbacks.

```MQLang
# Anonymous function with default parameter
let multiply = fn(x, factor=2): x * factor;

# Using default value
multiply(10)
# Multiplies each value by 2 (default factor)

# Overriding default value
multiply(10, 3)
# Multiplies each value by 10

# Using in callbacks
[1, 2] | map(fn(x, prefix="Item: "): prefix + to_text(x);)
```

--------------------------------

### Clone mq repository and install dependencies

Source: https://mqlang.org/book/print

Clones the mq source code repository from GitHub and installs development dependencies using 'cargo' or 'asdf'. This is for developers contributing to mq.

```bash
git clone https://github.com/harehare/mq.git
cd mq
```

```bash
# Using cargo
cargo install just wasm-pack
```

```bash
# Using asdf
asdf install
```

--------------------------------

### List Available mq Subcommands

Source: https://mqlang.org/book/print

This example shows how to use the `--list` flag with the 'mq' command to display all available subcommands. This is useful for discovering and managing custom extensions.

```bash
mq --list

```

--------------------------------

### mq Debugger Interactive Prompt Example (mqdbg)

Source: https://mqlang.org/book/start/debugger

Demonstrates the mq debugger's interactive prompt, showing the current execution point in the mq script.

```mqdbg
   10| def process_headers() {
=> 11|   . | select(.type == "heading")
   12|     | map(.level)
   13| }
(mqdbg)
```

--------------------------------

### Access Dictionary Elements Using `get` Function

Source: https://mqlang.org/book/reference/types_and_values

Illustrates alternative methods for accessing dictionary values using the `get` function, either directly or via pipe operator.

```MQLang
get(d, "name")   # Same as di["name"]
d | get("age")    # Same as d["age"]
```

--------------------------------

### Access Array Elements Using `get` Function

Source: https://mqlang.org/book/reference/types_and_values

Illustrates alternative methods for accessing array elements using the `get` function, either directly or via pipe operator.

```MQLang
get(arr, 0)    # Same as arr[0]
arr | get(2)    # Same as arr[2]
```

--------------------------------

### MQLang Basic Anonymous Function Examples

Source: https://mqlang.org/book/reference/fn

Demonstrates the usage of basic anonymous functions in MQLang. Shows how they can be used with the `map` function for transformations and `sort_by` for ordering.

```MQLang
# Basic Anonymous Function
nodes | map(fn(x): add(x, "1");)

# Using Anonymous Functions as Callbacks
nodes | .[] | sort_by(fn(x): to_text(x);)
```

--------------------------------

### List Programming Languages in Code Blocks

Source: https://mqlang.org/book/start/example

This query retrieves a list of all programming languages used in the code blocks within a Markdown document. It helps in understanding the diversity of code examples present.

```mq
__
.code.lang
```

--------------------------------

### Comprehensive Function with Pattern Matching in MQLang

Source: https://mqlang.org/book/print

Provides an example of a function `describe` that uses extensive pattern matching to handle various data types including None, booleans, numbers, strings, arrays, and dictionaries.

```MQLang
def describe(value):
  match (value):
    | :none: "nothing"
    | :bool: "true or false"
    | x if (gt(x, 100)): "big number"
    | :number: "small number"
    | "": "empty string"
    | :string: "text"
    | []: "empty list"
    | [x]: s"list with one item: ${x}"
    | [_, ..rest]: "list with multiple items"
    | {}: "empty object"
    | _: "dictionary"
  end

```

--------------------------------

### Generate XML Sitemap from Markdown

Source: https://mqlang.org/book/start/example

This function generates an XML sitemap entry for each Markdown file. It takes the current file and a base URL to construct the `<loc>` and `<priority>` tags for the sitemap.

```mq
__
def sitemap(item, base_url):
    let path = replace(to_text(item), ".md", ".html")
    | let loc = base_url + path
    | s"<url>
  <loc>${loc}</loc>
  <priority>1.0</priority>
  </url>"
end
```

--------------------------------

### MQLang If Expression Example

Source: https://mqlang.org/book/reference/pattern_matching

A traditional if-elif-else structure demonstrating conditional logic based on type and value checks. This serves as a comparison to the more concise pattern matching approach.

```mqlang
__
if (type_of(x) == "number"):
  if (x == 0):
    "positive number"
  elif (x < 0):
    "negative number"
  else:
    "zero"
elif (type_of(x) == "array"):
  if (len(x) == 0):
    "empty array"
  else:
    "non-empty array"
else:
  "other"


```

--------------------------------

### Run mq-tui

Source: https://mqlang.org/book/start/tui

Launches the mq-tui interactive interface to process a specified Markdown file. This command allows you to start querying and exploring your Markdown content.

```bash
$ mq tui file.md
```

--------------------------------

### Slice Notation Index Clamping and Empty Slices

Source: https://mqlang.org/book/reference/types_and_values

Demonstrates how slice indices are clamped to the valid range of the array and how an empty slice is produced when start and end indices are equal.

```MQLang
let arr = [1, 2, 3, 4, 5]

arr[0:2]    # Returns [1, 2]
arr[3:10]   # Returns [4, 5] (end index clamped to array length)
arr[2:2]    # Returns [] (empty slice when start equals end)
```

--------------------------------

### View Sample MQ File with Bat Highlighting

Source: https://mqlang.org/book/start/syntax-highlighting

Displays the 'example.mq' file using 'bat' to demonstrate MQ syntax highlighting. This confirms that the syntax highlighting setup is working correctly for MQ files.

```bash
# View an mq file with syntax highlighting
bat example.mq
```

--------------------------------

### Create Sample MQ File

Source: https://mqlang.org/book/start/syntax-highlighting

Creates a sample MQ file named 'example.mq' with basic MQ syntax, including comments, function definitions, and a simple execution line. This file can be used to test MQ processing and syntax highlighting.

```bash
cat > example.mq << 'EOF'
# This is a comment
def greet(name):
  s"Hello, ${name}!"
end

.h | .text | greet("World")
EOF
```

--------------------------------

### Transform array elements using map

Source: https://mqlang.org/book/start/example

Demonstrates the `map` function in MQLang, which applies a given function to each element of an array and returns a new array with the transformed elements. This is useful for performing the same operation on all items in a collection.

```MQLang
map([1, 2, 3, 4, 5], fn(x): x + 1;)
```

--------------------------------

### Dictionary Access in MQ

Source: https://mqlang.org/book/print

Shows how to access dictionary values using square bracket notation with keys, and alternatively using the `get` function or pipe operator.

```mq
let d = {"name": "Alice", "age": 30, "city": "Tokyo"}

d["name"]   # Returns "Alice"
d["age"]    # Returns 30
d["city"]   # Returns "Tokyo"
```

```mq
get(d, "name")   # Same as di["name"]
d | get("age")    # Same as d["age"]
```

--------------------------------

### List available mq functions

Source: https://mqlang.org/book/start/mcp

The `available_functions` tool returns a JSON object containing all available mq functions, including their descriptions, parameters, and examples. This helps users understand the capabilities of mq.

```javascript
available_functions()
```

--------------------------------

### MQLang Array Access

Source: https://mqlang.org/book/print

Demonstrates how to access elements within an array in MQLang using both bracket notation and the `get` function. It highlights zero-based indexing and how out-of-bounds access returns `None`.

```mqlang
let arr = [1, 2, 3, 4, 5]

arr[0]     # Returns 1 (first element)
arr[2]     # Returns 3 (third element)
arr[6]     # Returns None

# Using the get function explicitly:
get(arr, 0)    # Same as arr[0]
arr | get(2)    # Same as arr[2]
```

--------------------------------

### Select MDX Components from Markdown

Source: https://mqlang.org/book/start/example

This query selects all MDX components (JSX-like elements embedded in Markdown) from a document. It's useful for processing or extracting custom components within Markdown files.

```mq
__
select(is_mdx())
```

--------------------------------

### mq CLI Usage and Commands

Source: https://mqlang.org/book/reference/cli

This snippet shows the basic usage of the mq command-line tool, including available commands like 'repl', 'fmt', and 'help'. It outlines how to specify queries, files, and options for processing markdown content.

```bash
Usage: mq [OPTIONS] [QUERY OR FILE] [FILES]... [COMMAND]

Commands:
  repl  Start a REPL session for interactive query execution
  fmt   Format mq files based on specified formatting options
  help  Print this message or the help of the given subcommand(s)

Arguments:
  [QUERY OR FILE]  
  [FILES]...       
```

--------------------------------

### Create Bat Syntax Directory

Source: https://mqlang.org/book/start/syntax-highlighting

Creates the necessary directory for custom syntax files in 'bat' if it does not already exist. This is the first step to enable syntax highlighting for MQ files.

```bash
mkdir -p "$(bat --config-dir)/syntaxes"
```

--------------------------------

### View MQ File with Bat Syntax Highlighting

Source: https://mqlang.org/book/start/syntax-highlighting

Displays an MQ file using the 'bat' command, applying syntax highlighting based on the previously configured MQ syntax file. This allows for better readability of MQ code.

```bash
# View an mq file with syntax highlighting
bat query.mq
```

--------------------------------

### Download MQ Syntax File for Bat

Source: https://mqlang.org/book/start/syntax-highlighting

Downloads the MQ Sublime syntax file from a GitHub repository and saves it to the 'bat' custom syntax directory. This enables 'bat' to recognize and highlight MQ code.

```bash
curl -o "$(bat --config-dir)/syntaxes/mq.sublime-syntax" \
  https://raw.githubusercontent.com/harehare/mq/main/assets/mq.sublime-syntax
```

--------------------------------

### mq CLI Options for Input and Output

Source: https://mqlang.org/book/reference/cli

This snippet details the various options available for the mq command-line tool, focusing on input and output formats, file handling, and processing modes. It includes options for aggregating files, loading filters from files, setting input/output formats, and enabling streaming.

```bash
-A, --aggregate
          Aggregate all input files/content into a single array
-f, --from-file
          load filter from the file
-I, --input-format <INPUT_FORMAT>
          Set input format [possible values: markdown, mdx, html, text, null, raw]
-L, --directory <MODULE_DIRECTORIES>
          Search modules from the directory
-M, --module-names <MODULE_NAMES>
          Load additional modules from specified files
      --args <NAME> <VALUE>
          Sets string that can be referenced at runtime
      --rawfile <NAME> <FILE>
          Sets file contents that can be referenced at runtime
      --stream
          Enable streaming mode for processing large files line by line
      --json
          Include the built-in JSON module
      --csv
          Include the built-in CSV module
      --fuzzy
          Include the built-in Fuzzy module
      --yaml
          Include the built-in YAML module
      --toml
          Include the built-in TOML module
      --xml
          Include the built-in XML module
      --test
          Include the built-in test module
-F, --output-format <OUTPUT_FORMAT>
          Set output format [default: markdown] [possible values: markdown, html, text, json, none]
-U, --update
          Update the input markdown (aliases: -i, --in-place, --inplace)
      --unbuffered
          Unbuffered output
      --list-style <LIST_STYLE>
          Set the list style for markdown output [default: dash] [possible values: dash, plus, star]
      --link-title-style <LINK_TITLE_STYLE>
          Set the link title surround style for markdown output [default: double] [possible values: double, single, paren]
      --link-url-style <LINK_URL_STYLE>
          Set the link URL surround style for markdown links [default: none] [possible values: none, angle]
-S, --separator <QUERY>
          Specify a query to insert between files as a separator
-o, --output <FILE>
          Output to the specified file
-C, --color-output
          Colorize markdown output
      --list
          List all available subcommands (built-in and external)
-P <PARALLEL_THRESHOLD>
          Number of files to process before switching to parallel processing [default: 10]
-h, --help
          Print help
-V, --version
          Print version
```

--------------------------------

### Extract Subarrays Using Slice Notation

Source: https://mqlang.org/book/reference/types_and_values

Explains how to extract subarrays from an array using slice notation `arr[start:end]`. It covers inclusive start and exclusive end indices and out-of-bounds clamping.

```MQLang
let arr = [1, 2, 3, 4, 5]

arr[1:4]    # Returns [2, 3, 4] (elements from index 1 to 3)
arr[0:3]    # Returns [1, 2, 3] (first three elements)
arr[2:5]    # Returns [3, 4, 5] (elements from index 2 to end)
```

--------------------------------

### Configure bat for mq syntax highlighting

Source: https://mqlang.org/book/print

Sets up syntax highlighting for mq files in the 'bat' command-line tool. This involves creating a directory, copying the syntax file, and rebuilding the cache.

```bash
mkdir -p "$(bat --config-dir)/syntaxes"

# Clone the mq repository or download mq.sublime-syntax
curl -o "$(bat --config-dir)/syntaxes/mq.sublime-syntax" \
  https://raw.githubusercontent.com/harehare/mq/main/assets/mq.sublime-syntax

bat cache --build
```

--------------------------------

### Create Range of Numbers (MQLang)

Source: https://mqlang.org/book/builtins

The `range` function generates an array of numbers starting from a specified value, ending at another value, with an optional step increment. It requires start, end, and optionally step values.

```MQLang
range(start, end, step)
```

--------------------------------

### Array Slicing in MQ

Source: https://mqlang.org/book/print

Demonstrates how to extract subarrays from an array using slice notation `arr[start:end]`. Indices are zero-based, with `start` being inclusive and `end` exclusive. Out-of-bounds indices are clamped.

```mq
let arr = [1, 2, 3, 4, 5]

arr[1:4]    # Returns [2, 3, 4] (elements from index 1 to 3)
arr[0:3]    # Returns [1, 2, 3] (first three elements)
arr[2:5]    # Returns [3, 4, 5] (elements from index 2 to end)
```

```mq
let arr = [1, 2, 3, 4, 5]

arr[0:2]    # Returns [1, 2]
arr[3:10]   # Returns [4, 5] (end index clamped to array length)
arr[2:2]    # Returns [] (empty slice when start equals end)
```

--------------------------------

### MQLang Function Examples: Doubling, Positivity Check, Composition

Source: https://mqlang.org/book/reference/def

Demonstrates defining functions for common operations like doubling a number, checking if a number is positive using conditional logic (`gt`), and composing functions to perform sequential operations (`add` then `double`).

```MQLang
__
# Function that doubles input
def double(x):
  mul(x, 2);

# Function with conditional logic
def is_positive(x):
  gt(x, 0);

# Composition of functions
def add_then_double(x, y):
  add(x, y) | double(self);

```

--------------------------------

### MQLang Examples: Default Parameter Usage and Expressions

Source: https://mqlang.org/book/reference/def

Illustrates the practical application of default parameters in MQLang, including overriding defaults, using default values, and defining default values as expressions. It highlights that default values are evaluated at call time.

```MQLang
__
# Function with default parameter
def greet(name, greeting="Hello"):
  greeting + " " + name;

# Using default value
greet("Alice")
# Output: "Hello Alice"

# Overriding default value
greet("Bob", "Hi")
# Output: "Hi Bob"

# Default value can be an expression
def add_with_offset(x, offset=10 + 5):
  x + offset;

add_with_offset(20)
# Output: 35

```

--------------------------------

### Get Current Timestamp (MQLang)

Source: https://mqlang.org/book/builtins

The `now` function returns the current system timestamp.

```MQLang
now()
```

--------------------------------

### mqcr Command-Line Options

Source: https://mqlang.org/book/start/crawler

Details the available command-line options for mqcr, including output directory, crawl delay, robots.txt path, and mq-lang query specification.

```bash
-o, --output <OUTPUT>: Directory to save markdown files (stdout if not specified)
-c, --crawl-delay <CRAWL_DELAY>: Delay between requests in seconds (default: 1)
--robots-path <ROBOTS_PATH>: Custom robots.txt URL
-m, --mq-query <MQ_QUERY>: mq-lang query for processing content (default: `identity()`)
```

--------------------------------

### Get Last Element of an Array (MQLang)

Source: https://mqlang.org/book/builtins

The `last` function retrieves the final element from an array. It accepts an array as input.

```MQLang
last(arr)
```

--------------------------------

### Get Dictionary Entries

Source: https://mqlang.org/book/builtins

Returns an array of key-value pairs from a dictionary, where each pair is represented as an array. It takes a dictionary as input.

```MQLang
entries(dict)
```

--------------------------------

### Create and Use a Custom mq Subcommand (Bash)

Source: https://mqlang.org/book/start/external_subcommands

This snippet demonstrates how to create a custom subcommand for 'mq' using a bash script. It involves creating an executable file named 'mq-hello' in the '~/.mq/bin/' directory, making it executable, and then calling it with arguments. The output shows the custom message and the arguments passed to the script.

```bash
# Create a custom subcommand
cat > ~/.mq/bin/mq-hello << 'EOF'
#!/bin/bash
echo "Hello from mq-hello!"
echo "Arguments: $@"
EOF
chmod +x ~/.mq/bin/mq-hello

# Use the custom subcommand
mq hello world
# Output: Hello from mq-hello!
#         Arguments: world
```

--------------------------------

### Get Markdown Attribute

Source: https://mqlang.org/book/builtins

Retrieves the value of a specified attribute from a markdown node. It requires the markdown node and the attribute name.

```MQLang
attr(markdown, attribute)
```

--------------------------------

### MQ Development Commands

Source: https://mqlang.org/book/start/development

Provides a list of common development commands for the MQ project, executed using the 'just' command runner. These include running the CLI, testing, linting, building, and updating documentation.

```bash
# Run the CLI with the provided arguments
just run '.code'
```

```bash
# Run formatting, linting and all tests
just test
```

```bash
# Run formatter and linter
just lint
```

```bash
# Build the project in release mode
just build
```

```bash
# Update documentation
just docs
```

--------------------------------

### Get All Interned Symbols

Source: https://mqlang.org/book/builtins

Returns an array containing all interned symbols within the MQLang environment. This function takes no arguments.

```MQLang
all_symbols()
```

--------------------------------

### mq CLI Usage

Source: https://mqlang.org/book/reference/cli

General usage instructions for the mq command-line tool, including arguments and options.

```APIDOC
## mq CLI Usage

### Description
The mq command-line interface provides tools for querying and manipulating markdown content.

### Method
CLI

### Endpoint
N/A

### Parameters
#### Path Parameters
- **QUERY OR FILE** (string) - Optional - The query to execute or the input file.
- **FILES...** (string) - Optional - Additional input files to process.

#### Query Parameters
N/A

#### Request Body
N/A

### Options
- **-A, --aggregate** (boolean) - Aggregate all input files/content into a single array.
- **-f, --from-file** (string) - Load filter from the file.
- **-I, --input-format <INPUT_FORMAT>** (string) - Set input format. Possible values: markdown, mdx, html, text, null, raw.
- **-L, --directory <MODULE_DIRECTORIES>** (string) - Search modules from the directory.
- **-M, --module-names <MODULE_NAMES>** (string) - Load additional modules from specified files.
- **--args <NAME> <VALUE>** (string) - Sets string that can be referenced at runtime.
- **--rawfile <NAME> <FILE>** (string) - Sets file contents that can be referenced at runtime.
- **--stream** (boolean) - Enable streaming mode for processing large files line by line.
- **--json** (boolean) - Include the built-in JSON module.
- **--csv** (boolean) - Include the built-in CSV module.
- **--fuzzy** (boolean) - Include the built-in Fuzzy module.
- **--yaml** (boolean) - Include the built-in YAML module.
- **--toml** (boolean) - Include the built-in TOML module.
- **--xml** (boolean) - Include the built-in XML module.
- **--test** (boolean) - Include the built-in test module.
- **-F, --output-format <OUTPUT_FORMAT>** (string) - Set output format. Default: markdown. Possible values: markdown, html, text, json, none.
- **-U, --update** (boolean) - Update the input markdown (aliases: -i, --in-place, --inplace).
- **--unbuffered** (boolean) - Unbuffered output.
- **--list-style <LIST_STYLE>** (string) - Set the list style for markdown output. Default: dash. Possible values: dash, plus, star.
- **--link-title-style <LINK_TITLE_STYLE>** (string) - Set the link title surround style for markdown output. Default: double. Possible values: double, single, paren.
- **--link-url-style <LINK_URL_STYLE>** (string) - Set the link URL surround style for markdown links. Default: none. Possible values: none, angle.
- **-S, --separator <QUERY>** (string) - Specify a query to insert between files as a separator.
- **-o, --output <FILE>** (string) - Output to the specified file.
- **-C, --color-output** (boolean) - Colorize markdown output.
- **--list** (boolean) - List all available subcommands (built-in and external).
- **-P <PARALLEL_THRESHOLD>** (integer) - Number of files to process before switching to parallel processing. Default: 10.
- **-h, --help** (boolean) - Print help.
- **-V, --version** (boolean) - Print version.

### Request Example
```bash
mq 'query' file.md
```

### Response
N/A
```

--------------------------------

### Get Dictionary Keys (MQLang)

Source: https://mqlang.org/book/builtins

The `keys` function extracts all keys from a given dictionary and returns them as an array. It takes a dictionary as input.

```MQLang
keys(dict)
```

--------------------------------

### get

Source: https://mqlang.org/book/builtins

Retrieves a value from a dictionary by its key. Returns None if the key is not found. This function is essential for accessing data stored in dictionaries.

```APIDOC
## get

### Description
Retrieves a value from a dict by its key. Returns None if the key is not found.

### Method
N/A

### Endpoint
`get(obj, key)`

### Parameters
#### Path Parameters
- **obj** (object) - Required - The dictionary to retrieve the value from.
- **key** (string) - Required - The key to look up in the dictionary.

### Request Example
```json
{
  "obj": {"name": "John", "age": 30},
  "key": "name"
}
```

### Response
#### Success Response (200)
- **value** (any) - The value associated with the key, or None if not found.

#### Response Example
```json
"John"
```
```

--------------------------------

### Get First Element of Array

Source: https://mqlang.org/book/builtins

Returns the first element of an array. If the array is empty, the behavior is undefined or may return None.

```MQLang
first(arr)
```

--------------------------------

### Combine Markdown Files with Path Separators

Source: https://mqlang.org/book/start/example

Demonstrates how to combine multiple Markdown files using the MQLang command-line tool. The `-S` flag inserts a file path separator between the content of each file, and `__FILE__` represents the current file path. This is useful for processing and concatenating documentation from various sources.

```Shell
$ mq -S 's"\n${__FILE__}\n"' 'identity()' docs/books/**/**.md
```

--------------------------------

### Use mq in GitHub Actions

Source: https://mqlang.org/book/start/install

Integrates mq into GitHub Actions workflows using the 'setup-mq' action. This allows you to run mq commands within your CI/CD pipelines.

```yaml
steps:
  - uses: actions/checkout@v4
  - uses: harehare/setup-mq@v1
  - run: mq '.code' README.md
```

--------------------------------

### Array Access

Source: https://mqlang.org/book/print

Demonstrates how to access elements within arrays using index notation and the `get` function.

```APIDOC
## Array Access

### Description
This section explains how to access elements within arrays in mq, utilizing both direct index notation and the explicit `get` function.

### Index Notation
Arrays can be accessed using square bracket notation with zero-based indexing.

### Request Example
```javascript
let arr = [1, 2, 3, 4, 5]

arr[0]     // Returns 1 (first element)
arr[2]     // Returns 3 (third element)
arr[6]     // Returns None (index out of bounds)
```

### Using the `get` Function
You can also use the `get` function explicitly for accessing array elements, which provides an alternative syntax.

### Request Example
```javascript
get(arr, 0)    // Same as arr[0]
arr | get(2)    // Same as arr[2]
```
```

--------------------------------

### Transform Array Elements with Map

Source: https://mqlang.org/book/print

Applies a transformation function to each element of an array. In this example, it adds 1 to each element.

```MQ
__
map([1, 2, 3, 4, 5], fn(x): x + 1;)
```

--------------------------------

### List Available mq Subcommands

Source: https://mqlang.org/book/start/external_subcommands

This command shows how to list all available subcommands for the 'mq' tool, including any custom subcommands that have been added. This is useful for discovering and verifying the functionality of both built-in and user-defined commands.

```bash
mq --list
```

--------------------------------

### Filter Sections with Content

Source: https://mqlang.org/book/start/example

This query filters sections to include only those that contain content beyond just the header. It then returns the titles of these non-empty sections.

```mq
__
include "section" | nodes | sections() | filter(fn(s): has_content(s);) | titles()
```

--------------------------------

### Get Second Element of Array (MQLang)

Source: https://mqlang.org/book/builtins

The `second` function retrieves the element at the second position (index 1) from an array. It requires the array as input.

```MQLang
second(arr)
```

--------------------------------

### get_or

Source: https://mqlang.org/book/builtins

Safely gets a value from a dictionary, providing a default value if the key doesn't exist. This prevents errors when accessing potentially missing keys.

```APIDOC
## get_or

### Description
Safely gets a value from a dict with a default if the key doesn't exist.

### Method
N/A

### Endpoint
`get_or(dict, key, default)`

### Parameters
#### Path Parameters
- **dict** (object) - Required - The dictionary to retrieve the value from.
- **key** (string) - Required - The key to look up in the dictionary.
- **default** (any) - Required - The default value to return if the key is not found.

### Request Example
```json
{
  "dict": {"name": "John"},
  "key": "age",
  "default": 0
}
```

### Response
#### Success Response (200)
- **value** (any) - The value associated with the key, or the default value if not found.

#### Response Example
```json
0
```
```

--------------------------------

### Run mq Script with Debugger (Shell)

Source: https://mqlang.org/book/start/debugger

Launches the mq debugger to execute an mq script. The debugger will pause execution at breakpoints or the start of the script.

```shell
# Enable debugging for an mq script
mq-dbg -f your-script.mq input.md
```

--------------------------------

### Filter Array Elements by Condition

Source: https://mqlang.org/book/print

Selects elements from an array that satisfy a given condition. This example filters for numbers greater than 10.

```MQ
__
filter([5, 15, 8, 20, 3], fn(x): x > 10;)
```

--------------------------------

### Configure mq MCP server in Claude Desktop

Source: https://mqlang.org/book/start/mcp

Add the mq MCP server configuration to your Claude Desktop settings. This involves specifying the command and arguments to run the mq binary.

```json
{
  "mcpServers": {
    "mq": {
      "command": "/path/to/mq",
      "args": ["mcp"]
    }
  }
}
```

--------------------------------

### mqcr Command-Line Usage

Source: https://mqlang.org/book/start/crawler

Demonstrates the basic syntax for using the mqcr command-line tool. It requires a URL as a primary argument and accepts various options for customization.

```bash
mqcr [OPTIONS] <URL>
```

--------------------------------

### Doc-Comments in MQLang

Source: https://mqlang.org/book/print

MQLang supports documentation comments that start with '#'. These comments are ignored during execution but can be used for code explanation and documentation generation.

```MQLang
# doc-comment
let value = add(2, 3);
```
Tokens:
Raw