操作系统信息

GitHub npm crates.io

API Reference

使用 OS 信息插件阅读有关操作系统的信息。

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

支持的平台

¥Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

¥Setup

安装 OS 信息插件以开始使用。

¥Install the OS Information plugin to get started.

Automatic

使用项目的包管理器添加依赖：

¥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

deno

deno task tauri add os

bun

bun tauri add os

cargo

cargo tauri add os

Manual

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

   cargo add tauri-plugin-os

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .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

   deno

   deno add npm:@tauri-apps/plugin-os

   bun

   bun add @tauri-apps/plugin-os

使用

¥Usage

使用此插件，你可以从当前操作系统查询多种信息。在 JavaScript API 参考中查看所有 JavaScript API。

¥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 返回一个字符串，描述正在使用的特定操作系统。该值在编译时设置。可能的值是 linux、macos、ios、freebsd、dragonfly、netbsd、openbsd、solaris、android、windows。

¥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';
// when using `"withGlobalTauri": true`, you may use
// const { platform } = window.__TAURI__.os;

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

Rust

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

权限

¥Permissions

默认情况下，所有潜在危险的插件命令和范围都会被阻止，无法访问。你必须修改 capabilities 配置中的权限才能启用这些权限。

¥By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

有关更详细的说明，请参阅 功能概述。

¥See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "os:default"
  ]
}

Default Permission

This permission set configures which operating system information are available to gather from the frontend.

Granted Permissions

All information except the host name are available.

This default permission set includes the following:

• allow-arch
• allow-exe-extension
• allow-family
• allow-locale
• allow-os-type
• allow-platform
• allow-version

Permission Table

Identifier	Description
os:allow-arch	Enables the arch command without any pre-configured scope.
os:deny-arch	Denies the arch command without any pre-configured scope.
os:allow-exe-extension	Enables the exe_extension command without any pre-configured scope.
os:deny-exe-extension	Denies the exe_extension command without any pre-configured scope.
os:allow-family	Enables the family command without any pre-configured scope.
os:deny-family	Denies the family command without any pre-configured scope.
os:allow-hostname	Enables the hostname command without any pre-configured scope.
os:deny-hostname	Denies the hostname command without any pre-configured scope.
os:allow-locale	Enables the locale command without any pre-configured scope.
os:deny-locale	Denies the locale command without any pre-configured scope.
os:allow-os-type	Enables the os_type command without any pre-configured scope.
os:deny-os-type	Denies the os_type command without any pre-configured scope.
os:allow-platform	Enables the platform command without any pre-configured scope.
os:deny-platform	Denies the platform command without any pre-configured scope.
os:allow-version	Enables the version command without any pre-configured scope.
os:deny-version	Denies the version command without any pre-configured scope.