Tauri CLI 配置

2024-01-30 11:03 更新

描述 CLI 配置

类型：object

名字	类型	违约	描述
`description`	`string`?	零	命令说明，将显示在帮助信息中。
`longDescription`	`string`?	零	命令详细说明，将显示在帮助信息中。
`beforeHelp`	`string`?	零	除了自动生成的帮助外，还添加要显示的其他帮助信息。此信息显示在自动生成的帮助信息之前。这通常用于标头信息。
`afterHelp`	`string`?	零	除了自动生成的帮助外，还添加要显示的其他帮助信息。此信息显示在自动生成的帮助信息之后。这通常用于描述如何使用参数或要注意的注意事项。
`args`	`array`?	零	命令的参数列表
`subcommands`	`object`?	零	此命令的子命令列表

Cli参数

CLI 参数定义。

类型：object

名字	类型	违约	描述
`short`	`string`?	零	参数的简短版本，不带前面的 -。注意：任何主要角色都将被剥离，只有第一个非角色将用作简短版本。`-`
`name`	`string`（必填）	零	唯一参数名称
`description`	`string`?	零	将显示在帮助信息中的参数说明。通常，这是对 arg 的简短（一行）描述。
`longDescription`	`string`?	零	参数详细说明，将显示在帮助信息上。通常，这是描述参数的更详细（多行）消息。
`takesValue`	`boolean`	`false`	指定参数在运行时采用一个值。注意：可以在以下任何方法中指定参数的值 - 使用空格，如 -o 值或 --option 值 - 使用等于且无空格，如 -o=value 或 --option=value- 使用短且无空格，如 -ovalue
`multiple`	`boolean`	`false`	指定参数可以具有未知数目的多个值。如果没有任何其他设置，此参数可能只出现一次。例如，--opt val1 val2 是允许的，但 --opt val1 val2 --opt val3 是不允许的。注意：设置此项需要设置为 true。 `takes_value`
`multipleOccurrences`	`boolean`	`false`	指定参数可以多次出现。对于标志，这将导致记录标志的出现次数。例如，-ddd 或 -d -d -d 将计为出现 3 次。对于采用值的选项或参数，这不会影响它们可以接受的值数。（即一次只允许一个）例如，--opt val1 --opt val2 是允许的，但 --opt val1 val2 是不允许的。
`numberOfValues`	`integer`?（格式：`UInt`）	零	指定满足此参数所需的值数。例如，如果您有一个参数，您恰好想要 3 个“文件”，您将设置，除非用户提供 3 个且仅提供 3 个值，否则此参数将不满足。注意：不需要设置。设置将允许 where 如果不设置它，它只允许出现一次此参数。注意：隐式设置和 .`-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`?	零	指定此参数的可能值列表。在运行时，CLI 会验证是否仅使用了指定的值之一，否则将失败并显示错误消息。
`minValues`	`integer`?（格式：`UInt`）	零	指定此参数的最小值数。例如，如果您有一个 -f 参数，其中您至少需要 2 个“文件”，则需要设置，如果用户提供 2 个或更多值，则此参数将得到满足。`<file>minValues: 2`
`maxValues`	`integer`?（格式：`UInt`）	零	指定此参数的最大值数。例如，如果您有一个 -f 参数，您最多需要 3 个“文件”，您将设置 .max_values（3），如果用户提供 1、2 或 3 个值，则此参数将得到满足。`<file>`
`required`	`boolean`	`false`	设置默认情况下是否需要参数。 - 默认情况下，“必需”意味着在未评估其他冲突规则时是必需的 - 冲突规则优先于必需规则。
`requiredUnlessPresent`	`string`?	零	设置一个覆盖此参数的必需设置的参数，即除非存在此其他参数，否则此参数将是必需的。
`requiredUnlessPresentAll`	`array`?	零	设置覆盖此参数的必需设置的参数，即除非存在所有其他参数，否则此参数将是必需的。
`requiredUnlessPresentAny`	`array`?	零	设置覆盖此参数的必需设置的参数，即除非存在至少一个其他参数，否则将需要此参数。
`conflictsWith`	`string`?	零	按名称设置冲突的参数，即使用此参数时，以下参数不能存在，反之亦然。
`conflictsWithAll`	`array`?	零	与 conflictsWith 相同，但允许为每个参数指定多个双向冲突。
`requires`	`string`?	零	按名称排列一个参数，当这个参数存在时，这个参数是必需的，即当使用这个参数时，必须存在以下参数。
`requiresAll`	`array`?	零	按存在此参数时所需的名称对多个参数进行 Sts，即使用此参数时，必须存在以下参数。
`requiresIf`	`array`?	零	允许使用签名 [arg， value] 的条件要求，只有当的值等于时，该要求才会有效。`arg${value}`
`requiredIfEq`	`array`?	零	允许使用签名 [arg， value] 有条件地指定参数是必需的，只有当的值等于时，该要求才会有效。`arg${value}`
`requireEquals`	`boolean`?	零	要求选项使用 --option=val 语法，即选项和关联值之间的相等。
`index`	`integer`?（格式：`UInt`，最小值：`1`）	零	位置参数索引，从 1 开始。该指数是指根据其他位置参数的位置。它不定义整个参数列表中的位置。当与 multiple=true 一起使用时，只有最后一个位置参数可以定义为多个参数（即具有最高索引的参数）。

以上内容是否对您有帮助：