Tauri CLI 配置

2024-01-30 11:03 更新

描述 CLI 配置

類型：object

名字類型違約描述
description
string?零命令說明，將顯示在幫助信息中。
longDescription
string?零命令詳細(xì)說明，將顯示在幫助信息中。
beforeHelp
string?零除了自動生成的幫助外，還添加要顯示的其他幫助信息。此信息顯示在自動生成的幫助信息之前。這通常用于標(biāo)頭信息。
afterHelp
string?零除了自動生成的幫助外，還添加要顯示的其他幫助信息。此信息顯示在自動生成的幫助信息之后。這通常用于描述如何使用參數(shù)或要注意的注意事項。
args
array?零命令的參數(shù)列表
subcommands
object?零此命令的子命令列表

Cli參數(shù)

CLI 參數(shù)定義。

類型：object

名字類型違約描述
short
string?零參數(shù)的簡短版本，不帶前面的 -。

注意：任何主要角色都將被剝離，只有第一個非角色將用作簡短版本。-
name
string（必填）零唯一參數(shù)名稱
description
string?零將顯示在幫助信息中的參數(shù)說明。通常，這是對 arg 的簡短（一行）描述。
longDescription
string?零參數(shù)詳細(xì)說明，將顯示在幫助信息上。通常，這是描述參數(shù)的更詳細(xì)（多行）消息。
takesValue
booleanfalse指定參數(shù)在運行時采用一個值。

注意：可以在以下任何方法
中指定參數(shù)的值 - 使用空格，如 -o 值或 --option 值
- 使用等于且無空格，如 -o=value 或 --option=value- 使用短且無空格，如 -ovalue
multiple
booleanfalse指定參數(shù)可以具有未知數(shù)目的多個值。如果沒有任何其他設(shè)置，此參數(shù)可能只出現(xiàn)一次。

例如，--opt val1 val2 是允許的，但 --opt val1 val2 --opt val3 是不允許的。注意：設(shè)置此項需要設(shè)置為 true。

takes_value
multipleOccurrences
booleanfalse指定參數(shù)可以多次出現(xiàn)。對于標(biāo)志，這將導(dǎo)致記錄標(biāo)志的出現(xiàn)次數(shù)。例如，-ddd 或 -d -d -d 將計為出現(xiàn) 3 次。對于采用值的選項或參數(shù)，這不會影響它們可以接受的值數(shù)。（即一次只允許一個）

例如，--opt val1 --opt val2 是允許的，但 --opt val1 val2 是不允許的。
numberOfValues
integer?（格式：UInt）零指定滿足此參數(shù)所需的值數(shù)。例如，如果您有一個參數(shù)，您恰好想要 3 個“文件”，您將設(shè)置 ，除非用戶提供 3 個且僅提供 3 個值，否則此參數(shù)將不滿足。

注意：不需要設(shè)置。設(shè)置將允許 where 如果不設(shè)置它，它只允許出現(xiàn)一次此參數(shù)。

注意：隱式設(shè)置和 .-f <file>number_of_values = 3multiple_occurrences = truemultiple_occurrences = true-f <file> <file> <file> -f <file> <file> <file>takes_value = truemultiple_values = true
possibleValues
array?零指定此參數(shù)的可能值列表。在運行時，CLI 會驗證是否僅使用了指定的值之一，否則將失敗并顯示錯誤消息。
minValues
integer?（格式：UInt）零指定此參數(shù)的最小值數(shù)。例如，如果您有一個 -f 參數(shù)，其中您至少需要 2 個“文件”，則需要設(shè)置 ，如果用戶提供 2 個或更多值，則此參數(shù)將得到滿足。<file>minValues: 2
maxValues
integer?（格式：UInt）零指定此參數(shù)的最大值數(shù)。例如，如果您有一個 -f 參數(shù)，您最多需要 3 個“文件”，您將設(shè)置 .max_values（3），如果用戶提供 1、2 或 3 個值，則此參數(shù)將得到滿足。<file>
required
booleanfalse設(shè)置默認(rèn)情況下是否需要參數(shù)。

- 默認(rèn)情況下，“必需”意味著在未評估其他沖突規(guī)則時是必需的
- 沖突規(guī)則優(yōu)先于必需規(guī)則。
requiredUnlessPresent
string?零設(shè)置一個覆蓋此參數(shù)的必需設(shè)置的參數(shù)，即除非存在此其他參數(shù)，否則此參數(shù)將是必需的。
requiredUnlessPresentAll
array?零設(shè)置覆蓋此參數(shù)的必需設(shè)置的參數(shù)，即除非存在所有其他參數(shù)，否則此參數(shù)將是必需的。
requiredUnlessPresentAny
array?零設(shè)置覆蓋此參數(shù)的必需設(shè)置的參數(shù)，即除非存在至少一個其他參數(shù)，否則將需要此參數(shù)。
conflictsWith
string?零按名稱設(shè)置沖突的參數(shù)，即使用此參數(shù)時，以下參數(shù)不能存在，反之亦然。
conflictsWithAll
array?零與 conflictsWith 相同，但允許為每個參數(shù)指定多個雙向沖突。
requires
string?零按名稱排列一個參數(shù)，當(dāng)這個參數(shù)存在時，這個參數(shù)是必需的，即當(dāng)使用這個參數(shù)時，必須存在以下參數(shù)。
requiresAll
array?零按存在此參數(shù)時所需的名稱對多個參數(shù)進(jìn)行 Sts，即使用此參數(shù)時，必須存在以下參數(shù)。
requiresIf
array?零允許使用簽名 [arg， value] 的條件要求，只有當(dāng) 的 值等于 時，該要求才會有效。arg${value}
requiredIfEq
array?零允許使用簽名 [arg， value] 有條件地指定參數(shù)是必需的，只有當(dāng) 的值等于 時，該要求才會有效。arg${value}
requireEquals
boolean?零要求選項使用 --option=val 語法，即選項和關(guān)聯(lián)值之間的相等。
index
integer?（格式：UInt，最小值：1）零位置參數(shù)索引，從 1 開始。

該指數(shù)是指根據(jù)其他位置參數(shù)的位置。它不定義整個參數(shù)列表中的位置。當(dāng)與 multiple=true 一起使用時，只有最后一個位置參數(shù)可以定義為多個參數(shù)（即具有最高索引的參數(shù)）。


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號