Apollo CLI

⚠️ 注意

所有apollo service:* 命令已弃用，现在推荐使用 Rover CLI.

Apollo CLI 提供了与 Apollo 平台的每个组件交互的有用命令，包括Apollo 客户端, Apollo 服务器, 和 GraphOS 工作室.

下载和安装

Apollo CLI 以 npm 的形式提供。

项目级别的安装（推荐）

如果你的项目使用 npm，我们建议将 Apollo CLI 安装到本地，方法是将它添加到项目的 devDependencies 中，如下所示：

npm install -D apollo

这有助于确保所有项目协作者的Apollo CLI安装版本一致。

全局安装

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

npm install -g apollo

提供API密钥

与所有其他工具一样，Apollo CLI需要API密钥才能与 GraphOS Studio 通信。为与项目相关的图获取一个图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

首页