OS Information

GitHub npm crates.io

API Reference

Read information about the operating system using the OS Information plugin.

Setup

Install the OS Information plugin to get started.

Automatic

1. Use your project’s package manager to add the dependency:

npm

npm run tauri add os

Yarn

yarn run tauri add os

pnpm

pnpm tauri add os

Cargo

cargo tauri add os

2. Modify lib.rs to initialize the plugin:

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        // Initialize the plugin
        .plugin(tauri_plugin_os::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Manual

1. Run cargo add tauri-plugin-os to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

lib.rs

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        // Initialize the plugin
        .plugin(tauri_plugin_os::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

3. If you’d like to use in JavaScript then install the npm package as well:

npm

npm install @tauri-apps/plugin-os

Yarn

yarn add @tauri-apps/plugin-os

pnpm

pnpm add @tauri-apps/plugin-os

Usage

With this plugin you can query multiple information from current operational system. See all available functions in the JavaScript API or Rust API references.

Example: OS Platform

platform returns a string describing the specific operating system in use. The value is set at compile time. Possible values are linux, macos, ios, freebsd, dragonfly, netbsd, openbsd, solaris, android, windows.

JavaScript

import { platform } from '@tauri-apps/plugin-os';

const platform = await platform();
console.log(platform);
// Prints "windows" to the console

Rust

let platform = tauri_plugin_os::platform();
println!("Platform: {}", platform);
// Prints "windows" to the terminal