One-click install
npx skills add https://github.com/ortus-boxlang/skills --skill bx-oshi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bx-oshi
Source: https://github.com/ortus-boxlang/skills/tree/main/boxlang-modules/bx-oshi
Command: npx skills add https://github.com/ortus-boxlang/skills --skill bx-oshi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

BoxLang scripts often need introspection into the host environment to make informed decisions, but accessing consistent OS and hardware data can be verbose. bx-oshi provides a unified interface to retrieve system and hardware information from within BoxLang.

Core Features & Use Cases

  • Access to OS information via getOperatingSystem() and system-level data via getSystemInfo()
  • Hardware details through getHardware(), including CPU, memory, disks, and sensors
  • Convenience BIFs to query processes, memory, and disk stats, enabling health checks and capacity planning
  • Use cases include health monitoring, deployment automation, and performance profiling in servers, desktops, and containers

Quick Start

Install bx-oshi and call getSystemInfo() to begin retrieving OS and hardware information.

Frequently Asked Questions about bx-oshi

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I retrieve OS and hardware information within BoxLang scripts?

To retrieve OS and hardware information in BoxLang, use bx-oshi to call functions like getSystemInfo(), getOperatingSystem(), and getHardware(). This allows you to observe system state and access CPU, memory, disk, and network metrics directly from your scripts.

What is the best way to perform system health checks and monitor hardware metrics in BoxLang?

System health checks and hardware monitoring in BoxLang are done using bx-oshi convenience BIFs. These built-in functions let you query processes, memory, and disk stats to observe system state and perform structured health checks across servers, desktops, and containers.

Does BoxLang provide built-in functions to query CPU, memory, and disk data for capacity planning?

Yes, BoxLang provides convenience BIFs via bx-oshi to query CPU, memory, and disk data. These functions retrieve hardware details and system-level data, enabling effective capacity planning and performance profiling within your applications.

Can I access system state and sensor data from BoxLang programs running in containers?

Yes, you can access system state and sensor data from BoxLang programs in containers. bx-oshi supports querying hardware information and system metrics across servers, desktops, and containers, making it suitable for deployment automation and monitoring.

How do I get started with querying hardware details and OS info using bx-oshi?

To get started querying hardware details and OS info, install bx-oshi and call getSystemInfo() in your BoxLang program. This provides a unified interface to begin retrieving system and hardware information for diagnostics and scripting tasks.