制作自己的 CLI

Tauri 让你的应用程序可以通过 clap（一个强大的命令行参数解析器）拥有一个 CLI。通过在 tauri.conf.json 文件中进行简单的 CLI 定义，你可以定义界面，并在 JavaScript 和/或 Rust 上读取其参数匹配映射。

基本配置

在 tauri.conf.json 下，你可以使用以下结构来配置界面

src-tauri/tauri.conf.json

{
  "tauri": {
    "cli": {
      "description": "", // command description that's shown on help
      "longDescription": "", // command long description that's shown on help
      "beforeHelp": "", // content to show before the help text
      "afterHelp": "", // content to show after the help text
      "args": [], // list of arguments of the command, we'll explain it later
      "subcommands": {
        "subcommand-name": {
          // configures a subcommand that is accessible
          // with `./app subcommand-name --arg1 --arg2 --etc`
          // configuration as above, with "description", "args", etc.
        }
      }
    }
  }
}

备注

此处的所有 JSON 配置均为示例，为了清晰起见，已省略许多其他字段。

添加参数

args 数组表示其命令或子命令接受的参数列表。您可以在此处找到有关如何配置它们的更多详细信息。

位置参数

位置参数由其在参数列表中的位置标识。使用以下配置

{
  "args": [
    {
      "name": "source",
      "index": 1,
      "takesValue": true
    },
    {
      "name": "destination",
      "index": 2,
      "takesValue": true
    }
  ]
}

用户可以将您的应用程序作为 ./app tauri.txt dest.txt 运行，并且 arg 匹配映射将定义 source 为 "tauri.txt"，将 destination 定义为 "dest.txt"。

命名参数

命名参数是 (键、值) 对，其中键标识值。使用以下配置

{
  "args": [
    {
      "name": "type",
      "short": "t",
      "takesValue": true,
      "multiple": true,
      "possibleValues": ["foo", "bar"]
    }
  ]
}

用户可以将您的应用程序作为 ./app --type foo bar、./app -t foo -t bar 或 ./app --type=foo,bar 运行，并且 arg 匹配映射将定义 type 为 ["foo", "bar"]。

标志参数

标志参数是一个独立的键，其存在或不存在为您的应用程序提供信息。使用以下配置

{
  "args": [
    {
      "name": "verbose",
      "short": "v",
      "multipleOccurrences": true
    }
  ]
}

用户可以将您的应用程序作为 ./app -v -v -v、./app --verbose --verbose --verbose 或 ./app -vvv 运行，并且 arg 匹配映射将定义 verbose 为 true，其中 occurrences = 3。

子命令

一些 CLI 应用程序具有作为子命令的其他接口。例如，git CLI 具有 git branch、git commit 和 git push。您可以使用 subcommands 数组定义其他嵌套接口

{
  "cli": {
    ...
    "subcommands": {
      "branch": {
        "args": []
      },
      "push": {
        "args": []
      }
    }
  }
}

其配置与根应用程序配置相同，具有 description、longDescription、args 等。

读取匹配项

Rust

fn main() {
  tauri::Builder::default()
    .setup(|app| {
      match app.get_cli_matches() {
        // `matches` here is a Struct with { args, subcommand }.
        // `args` is `HashMap<String, ArgData>` where `ArgData` is a struct with { value, occurrences }.
        // `subcommand` is `Option<Box<SubcommandMatches>>` where `SubcommandMatches` is a struct with { name, matches }.
        Ok(matches) => {
          println!("{:?}", matches)
        }
        Err(_) => {}
      }
      Ok(())
    })
    .run(tauri::generate_context!())
    .expect("error while running tauri application");
}

JavaScript

import { getMatches } from '@tauri-apps/api/cli'

getMatches().then((matches) => {
  // do something with the { args, subcommand } matches
})

完整文档

您可以在此处找到有关 CLI 配置的更多信息。