tinman

Tinman allows you to query information about the operating system, runtime and environment.

It’s useful for working around platform quirks or setting up global resource limits at startup. It’s not suitable as a monitoring library.

Types

CpuArchitecture

</>

The CPU architecture.

pub type CpuArchitecture {
  X64
  Arm64
  Arm
  Riscv64
}

Constructors

```
X64
```
```
Arm64
```
```
Arm
```
```
Riscv64
```

OperatingSystem

</>

The operating system platform.

pub type OperatingSystem {
  Linux
  Macos
  Windows
  FreeBsd
  OpenBsd
}

Constructors

```
Linux
```
```
Macos
```
```
Windows
```
```
FreeBsd
```
```
OpenBsd
```

Runtime

</>

The JavaScript or Erlang runtime.

pub type Runtime {
  Beam
  AtomVm
  Node
  Deno
  Bun
}

Constructors

```
Beam
```
```
AtomVm
```
```
Node
```
```
Deno
```
```
Bun
```

Version

</>

Version information.

pub type Version {
  Version(major: Int, minor: Int, patch: Int)
}

Constructors

Version(major: Int, minor: Int, patch: Int)

Values

available_parallelism

</>

pub fn available_parallelism() -> Int

Returns the recommended level of parallelism.

This is the number of available schedulers on Erlang, or the number of runtime threads on Javascript. Note that Javascript itself is always single-threaded by default.

container_runtime

</>

pub fn container_runtime() -> Result(ContainerRuntime, Nil)

Returns the detected container runtime. Detects Docker, Podman, and WSL environments. Returns Error(Nil) if no container could be detected.

cpu_architecture

</>

pub fn cpu_architecture() -> Result(CpuArchitecture, Nil)

Returns the CPU architecture. Returns Error(Nil) if the architecture cannot be determined or is unknown.

cpu_count

</>

pub fn cpu_count() -> Result(Int, Nil)

Returns the number of logical CPU cores. Returns Error(Nil) if the CPU count cannot be determined.

Note: Usually you want to use available_parallelism instead!

end_of_line

</>

pub fn end_of_line() -> String

Returns the end-of-line marker for the current platform. "\n" on Unix-like systems, "\r\n" on Windows.

executable_extension

</>

pub fn executable_extension() -> String

Returns the executable file extension for the current platform. ".exe" on Windows, "" (empty string) on Unix-like systems.

free_disk_space

</>

pub fn free_disk_space() -> Result(Int, Nil)

Returns the free disk space in bytes for the root/system drive. Uses df on Unix-like systems and PowerShell on Windows. Returns Error(Nil) if the information cannot be determined.

free_memory

</>

pub fn free_memory() -> Result(Int, Nil)

Returns the available system memory in bytes. When running inside a container, memory limits applied to the container are respected.

Note: This information is not exposed by the Erlang runtime system, and has to be queried from the operating system in various ways. Doing so might be unexpectedly slow, especially on Windows!

group_id

</>

pub fn group_id() -> Result(Int, Nil)

Returns the current group ID. Returns Error(Nil) if the group ID cannot be determined.

is_admin

</>

pub fn is_admin() -> Bool

Returns whether the current user has administrator/root privileges. On Unix-like systems, checks if the user ID is 0 (root). On Windows, checks if we can successfully run a utility with elevated privileges.

is_ci

</>

pub fn is_ci() -> Bool

Returns whether your program is running in a CI environment.

Checks for CI and CONTINUOUS_INTEGRATION environment variables.

is_in_ssh

</>

pub fn is_in_ssh() -> Bool

Returns whether your program is running in an SSH session.

Checks for SSH_CONNECTION, SSH_CLIENT, and SSH_TTY environment variables.

is_online

</>

pub fn is_online() -> Bool

Returns whether the system appears to be online.

Checks if there is an active non-loopback network interface available.

is_test

</>

pub fn is_test() -> Bool

Returns whether the program is running in test mode.

Checks if the entrypoint module is _test, which is the case when running with gleam test.

is_tty

</>

pub fn is_tty() -> Bool

Checks whether the program is running in an interactive terminal (TTY).

libc

</>

pub fn libc() -> Result(Libc, Nil)

Returns the C standard library type (Linux only). Returns Error(Nil) on non-Linux systems or if detection fails.

os

</>

pub fn os() -> Result(OperatingSystem, Nil)

Returns the operating system platform. Returns Error(Nil) if the platform cannot be determined or is unknown.

os_version

</>

pub fn os_version() -> Result(Version, Nil)

Returns the operating system version. Returns Error(Nil) if the version cannot be determined or parsed.

path_delimiter

</>

pub fn path_delimiter() -> String

Returns the path delimiter - the character used inside the PATH environment variable to separate multiple paths - for the current platform. ":" on Unix-like systems, ";" on Windows.

path_separator

</>

pub fn path_separator() -> String

Returns the path separator - the character used inside paths to separate files and directories - for the current platform. "/" on Unix-like systems, "\\" on Windows.

process_id

</>

pub fn process_id() -> Int

Returns the runtimes operating system process ID.

runtime

</>

pub fn runtime() -> Result(Runtime, Nil)

Returns the current runtime (Erlang, Node, Deno, or Bun). Returns Error(Nil) if the runtime cannot be determined.

runtime_version

</>

pub fn runtime_version() -> Result(Version, Nil)

Returns the runtime version. Returns Error(Nil) if the version cannot be determined or parsed.

Note: On Erlang, this is the version of the Erlang runtime system (ERTS), not the version of the OTP release!

total_disk_space

</>

pub fn total_disk_space() -> Result(Int, Nil)

Returns the total disk space in bytes for the root/system drive. Uses df on Unix-like systems and PowerShell on Windows. Returns Error(Nil) if the information cannot be determined.

total_memory

</>

pub fn total_memory() -> Result(Int, Nil)

Returns the total available system memory in bytes. When running inside a container, memory limits applied to the container are respected.

Note: This information is not exposed by the Erlang runtime system, and has to be queried from the operating system in various ways. Doing so might be unexpectedly slow, especially on Windows!

used_memory

</>

pub fn used_memory() -> Int

Returns the memory used by the runtime and your program.

user_id

</>

pub fn user_id() -> Result(Int, Nil)

Returns the current user ID. Returns Error(Nil) if the user ID cannot be determined.

user_name

</>

pub fn user_name() -> String

Returns the current username. Returns Error(Nil) if the username cannot be determined.