Postman CLI 命令选项（Command options）

使用 Postman CLI 的命令和选项。

基本命令行选项

Postman

这是基本命令，通常与collection runor 结合使用api lint。

例子

选项

选项	细节
--help,-h	返回有关 Postman CLI 命令和选项的信息。
--version,-v	返回 Postman CLI 的版本号。

登录和注销

login 你可以使用 Postman CLI 通过和命令登录和注销 Postman logout 。

Postman 登录

此命令对用户进行身份验证并在本地缓存 Postman API 密钥 。login需要一个选项，--with-api-key它接受 Postman API 密钥。login每个会话只需要一次该命令。登录后，你将保持登录状态，直到你使用该logout命令或你的 Postman API 密钥过期。

例子

postman login --with-api-key ABCD-1234-1234-1234-1234-1234

Postman 注销

此命令使你退出 Postman 并删除存储的 API 密钥。

例子

选项

选项	细节
--with-api-key [api-key]	使用给定的 API 密钥对用户进行身份验证。

运行集合

你可以使用以下postman collection run命令运行你的收藏：

Postman collection run

此命令运行一个集合并将所有运行结果和响应发送到 Postman 服务器。你可以使用文件路径或集合 ID 指定集合。

你可以在 Postman 中找到集合 ID。首先，在边栏中选择收藏集，然后选择一个收藏集。 然后选择右侧栏中的信息图标 以访问集合 ID。

例子

postman collection run /myCollectionFolderName/myCollectionFile.json

postman collection run 12345678-12345ab-1234-1ab2-1ab2-ab1234112a12

选项

选项	细节
--bail [optional modifiers]	指定是否在遇到第一个测试脚本错误时停止 collection run。--bail可以选择接受两个修饰符：--folder和--failure。--folder如果有任何错误，则跳过整个 collection run。如果测试失败，则--failure在完成当前测试脚本后优雅地停止 collection run。
--color [value]	控制彩色 CLI 输出。接受on、off和auto。默认为auto。使用auto，Postman CLI 会尝试根据终端中的颜色支持自动打开或关闭颜色。可以通过相应地使用 on 或 off 值来修改此行为。
--cookie-jar [path]	指定 cookie jar 的文件路径JSON。用于tough-cookie反序列化文件。
--delay-request [number]	指定请求之间的延迟（以毫秒为单位）。
--disable-unicode	用它们的纯文本等价物替换输出中的所有符号。
--environment [UID] or [file-path],-e	指定环境文件路径或 UID。
--env-var "[environment-variable-name]=[environment-variable-value]"	通过命令行以一种key=value格式指定环境变量。可以多次使用添加多个 CLI 环境变量--env-var，例如：--env-var "this=that" --env-var "alpha=beta".
--export-cookie-jar [path]	指定 Postman CLI 在完成运行之前输出最终 cookie jar 文件的路径。用于tough-cookie序列化文件。
--global-var "[global-variable-name]=[global-variable-value]"	通过命令行以一种key=value格式指定全局变量。可以多次使用添加多个 CLI 全局变量--global-var，例如：--global-var "this=that" --global-var "alpha=beta".
--globals [file-path],-g	指定全局变量的文件路径。全局变量类似于环境变量，但优先级较低，可以被同名的环境变量覆盖。
--iteration-count [number],-n	指定与迭代数据文件一起使用时集合将运行的次数。
--iteration-data [file-path] or [URL],-d	指定要用于迭代的数据源文件（JSON或CSV）作为文件路径或 URL。
-i [requestUID] or [folderUID]	仅运行指定的文件夹 UID 或从集合中请求 UID。可以通过指定多次来让多个 item 依次运行-i，例如：postman collection run collectionUID -i folder1UID -i folder2UID
-i [requestName] or [folderName]	仅运行集合中指定的文件夹名称或请求名称。如果存在重复名称，Postman CLI 将运行首先出现的文件夹或请求。
--ignore-redirects	防止 Postman CLI 自动遵循 3XX 重定向响应。
--insecure,-k	关闭 SSL 验证检查并允许自签名 SSL 证书。
--no-insecure-file-read	防止读取位于工作目录之外的文件。
--silent	关闭终端输出。
--suppress-exit-code,-x	指定是否覆盖当前运行的默认退出代码。
--timeout [number]	指定等待整个 collection run 完成执行的时间（以毫秒为单位）。
--timeout-request [number]	指定等待请求返回响应的时间（以毫秒为单位）。
--timeout-script [number]	指定等待脚本完成执行的时间（以毫秒为单位）。
--verbose	显示 collection run 和发送的每个请求的详细信息。
--working-dir [path]	设置在读取具有相对路径的文件时要使用的工作目录的路径。默认为当前目录。

Governance 和安全

API Governance 是在开发过程的 API 设计和测试阶段一致地应用一组定义的标准的实践。Postman CLI 包含一个命令，用于根据你团队配置的 Postman API Governance 和 API 安全规则检查你的 API 定义。（此功能仅适用于 企业团队 ）。

Postman api lint

此命令针对 Postman 配置文件、本地文件或 UUID 中提供的 API 定义运行 Governance 和安全规则的验证检查。api lint如果找不到将数据发送回 Postman 的 API ID，则会显示警告。

此命令支持存储在 Postman 上且未链接到 Git 的 API。

例子

postman api lint my-definition-file.json
postman api lint 8854915-bb7236b2-536e-4bdc-bfa2-fbe2fe1941eb

选项

选项	细节
--fail-severity [severity],-f	为达到或超过指定严重级别的规则违规触发退出失败代码。这些选项按严重程度从低到高依次为HINT、INFO、WARN和ERROR（默认）。
--suppress-exit-code,-x	指定是否覆盖当前运行的默认退出代码。

发布 API 版本

你可以使用 Postman CLI 从命令行 发布 API 版本。 这使你能够自动化 API 版本发布过程。

Postman 发布 api

发布给定 的 API 快照apiId。默认情况下，将发布链接到 API 的所有实体。你可以使用其他选项选择要发布的实体。

发布与 git 链接的 API 时，你必须从本地 git 存储库中输入命令，并提供架构目录的路径和集合路径，而不是 ID。

未与 git 链接的回购示例

postman api publish <apiId> --name v1\
--release-notes "# Some release notes information"\
--collections <collectionId1> <collectionId2>\
--api-definition <apiDefinitionId>

与 git 链接的 repos 示例

导航到 repo 并运行以下命令：

postman api publish <apiId> --name v1\
--release-notes "# Some release notes information"\
--collections <collectionPath1> <collectionPath2>\
--api-definition <schemaDirectoryPath>

选项

选项	细节
--name <name>	指定要发布的版本的名称。
--release-notes <releaseNotes>	在要发布的版本的引号中输入发行说明作为字符串。此选项支持降价。
--collections <collectionIds/paths...>	指定要发布的集合。如果 API 与 git 链接，请提供而filePath不是 ID。
--api-definition <apiDefinitionId/directory>	指定要发布的 API 定义。如果 API 与 git 链接，请提供而schemaDirectoryPath不是 ID。
--do-not-poll	指定不轮询发布操作的完成状态。
--suppress-exit-code, -x	指定是否覆盖当前运行的默认退出代码。