Displays a note to the user.

• prompt - The heading of the note
• msg - The message to display

api::utility::note("Next Steps", "Set your preferred shell, ...");

Displays a confirmation prompt to the user.

• msg - The message to display
• initial_value - The default selection (true/false)

if api::utility::confirm("Do you want to proceed?", true) { ... }

Displays a single-choice selection menu.

• msg - The message to display
• initial_value - The initially highlighted value
• items - An array of strings to choose from

let choice = api::utility::select(
  "Pick a color",
  "red",
  [["red", "Red", "a red color"],
  ["green", "Green", "a green color"],
  ["blue", "Blue", "a blue color"]]
);

Displays a multi-choice selection menu.

• msg - The message to display
• initial_values - Array of values to pre-select
• items - An array of all available options

let choice = api::utility::multi_select(
  "Pick colors",
  ["red", "green"],
  [["red", "Red", "a red color"],
  ["green", "Green", "a green color"],
  ["blue", "Blue", "a blue color"]]
);

Resolves `~` in a path to the user's home directory.

• path - The path string to resolve

let full_path = api::utility::resolve_home("~/Downloads");

Reads the entire content of a file into a string.

• path - Path to the file (may use ~ for $HOME)

let config = api::utility::read_file("~/.config/myapp/config.toml");

Writes a string to a file, optionally appending to existing content.

• path - Path to the file (may use ~ for $HOME)
• content - The string data to write
• append - If true, appends to the file; if false, overwrites it

api::utility::write_file("~/log.txt", "New entry\n", true);

Replaces occurrences in a string using a Regular Expression.

• input - The source string
• pattern - The Regex pattern to match
• replace - The replacement string

let cleaned = api::utility::regex_replace("Hello 123", "[0-9]+", "World");

Creates a temporary directory that is deleted when the handle is dropped.

let tmp = api::utility::create_tmp_dir();
let path = api::utility::get_tmp_path(tmp);

Returns the absolute path of a temporary directory handle.

• tmp_dir - The TmpDir handle

Removes a file from the filesystem.

• path - Path to the file

Recursively copies a directory or file to a destination.

• src - Source path
• dst - Destination path

Parses a JSON string into a Rhai Map or Array.

• json - The raw JSON string

let data = api::utility::parse_json("{\"key\": \"value\"}");
print(data.key);

Checks if a path exists on the filesystem.

• path - The path to check

Ensures a directory exists, creating it and any parents if necessary.

• path - The directory path