gsh - v1.1.4

gsh/runtime/runtime

Values

app_version

</> 
pub fn app_version(app_name: atom.Atom) -> String

Resolves the application version string for a loaded OTP application (e.g., gsh).

boot_app

</> 
pub fn boot_app(
  module: String,
) -> Result(dynamic.Dynamic, String)

Boots a background application module in an isolated Erlang process and returns its active PID.

compile_and_load

</> 
pub fn compile_and_load(
  erl_path: String,
  module_name: String,
) -> Result(Nil, String)

Compiles an Erlang source file (.erl) directly into memory and loads the resulting code into the BEAM code server without writing a .beam file to disk.

disable_raw_mode

</> 
pub fn disable_raw_mode() -> Result(Nil, tty.TerminalError)

Disables raw mode and restores standard cooked terminal mode.

enable_raw_mode

</> 
pub fn enable_raw_mode() -> Result(Nil, tty.TerminalError)

Enables raw mode on the active TTY stream to capture unbuffered keystrokes.

fix_logger_staircase

</> 
pub fn fix_logger_staircase() -> Nil

Intercepts and wraps the default Erlang logger output handler to convert \n into \r\n, preventing log staircasing artifacts when background processes log during raw-mode TTY sessions.

get_args

</> 
pub fn get_args() -> List(String)

Retrieves raw CLI arguments passed after the -- separator during shell boot. Utilized by the bootloader to identify background application modules to start.

get_exports

</> 
pub fn get_exports(module: String) -> List(String)

Dynamically inspects a loaded Erlang module’s exports table to return all public function names. Powers autocomplete suggestions for imported standard library and project modules.

hot_reload

</> 
pub fn hot_reload(module_path: String) -> Nil

Forces the Erlang code server to purge its active RAM cache for a module and reload the latest compiled artifact from disk.

Automatically translates Gleam module paths (e.g., gleam/httpc) to their BEAM atom equivalents (gleam@httpc).

load_and_run

</> 
pub fn load_and_run(
  module: String,
  function: String,
) -> Result(dynamic.Dynamic, dynamic.Dynamic)

Dynamically loads a .beam bytecode file into the VM and executes a designated function. Intercepts VM-level exceptions (e.g., badarg, function_clause) to prevent REPL process crashes.

pid_from_string

</> 
pub fn pid_from_string(pid: String) -> process.Pid

Converts a formatted string PID representation (e.g., "<0.83.0>") into a native Erlang Pid reference.

run_entry

</> 
pub fn run_entry(
  module: String,
  function: String,
) -> Result(dynamic.Dynamic, dynamic.Dynamic)

Safely executes an entrypoint function within an already loaded BEAM module, trapping runtime crashes and returning them as an error Result.

system_time

</> 
pub fn system_time() -> Int

Returns the current monotonic system time in microseconds.

system_version

</> 
pub fn system_version() -> String

Retrieves the running Erlang/OTP release and ERTS version string directly from the VM. Used to construct system information during startup banner rendering.

✨ Search Document