The Apollo CLI

使用npm的安装指南

⚠️ 注意

所有apollo service:* 命令现在已弃用，将使用 Rover CLI 的命令。

Apollo CLI 提供与 Apollo 平台不同组件交互的命令，包括 Apollo客户端、Apollo服务器和GraphOS。

下载和安装

Apollo CLI 可作为 npm 软件包。

项目级安装（推荐）

如果您的项目使用 npm，我们建议通过将其添加到项目的 devDependencies 中在本地安装 Apollo CLI，如下所示：

1
npm install -D apollo

这有助于确保项目所有协作人员都安装了相同的CLI版本。

全局安装

您可以使用以下命令在开发环境中全局安装CLI

1
npm install -g apollo

提供API密钥

与其他所有工具一样，Apollo CLI需要API密钥才能与GraphOS通信。对于您的每个项目，获取与项目相关联的图形API密钥，并将该密钥设置为您的应用程序的.env文件中的APOLLO_KEY值：

.env

1
APOLLO_KEY=service:docs-example-graph:NYKgCqwfCyYPIm84WVXCdw

或者，您可以使用--key选项为单个CLI命令提供API密钥：

1
apollo client:check --graph=MyGraph --key=service:docs-example-graph:NYKgCqwfCyYPIm84WVXCdw

支持的命令

Apollo CLI的大部分命令都在以下命名空间中：

客户端（例如apollo client:codegen）用于涉及 Apollo 客户端和 GraphOS Studio
服务（例如apollo service:check）用于涉及 Apollo Server 和 GraphOS Studio
⚠️ 注意
现在所有apollo service:*命令已被弃用，并推荐使用Rover CLI中的命令。

要查看特定命名空间下的所有命令清单，请使用 apollo help命令：

ⓘ 注意

如果您已全局安装了 Apollo CLI，请从以下示例命令中省略npx。

1
$ npx apollo help client
2
Check a client project against a pushed service
3

4
USAGE
5
  $ apollo client:COMMAND
6

7
COMMANDS
8
  client:check            Check a client project against a pushed service
9
  client:codegen          Generate static types for GraphQL queries. Can use the
10
                          published schema in the Apollo registry or a
11
                          downloaded schema.
12
  client:download-schema  Download a schema from Apollo or a GraphQL endpoint in
13
                          JSON or SDL format
14
  client:extract          Extract queries from a client
15
  client:push             Register operations with Apollo, adding them to the
16
                          safelist

您还可以以以下方式获取单个命令的完整选项集

1
$ npx apollo help client:codegen

模板

验证客户端操作