什么是 ngctl¶
ngctl 是用于管理悦数图数据库开发版 Meta 服务的命令行工具，可用于登录和登出 Meta 服务、修改用户密码以及管理用户。
使用场景¶
ngctl 可用于以下场景：
- 首次使用 Docker Compose 部署悦数图数据库开发版时，ngctl 会自动设置密码并初始化默认服务组。
- 登录 Meta 服务以获取 Meta 访问令牌。
- 在 Meta 服务中管理用户。
- 配置会话无状态模式，该模式需要登录 Meta 服务。
在 Docker Compose 部署中运行¶
配套的compose.yaml会启动ngctl容器。悦数图数据库开发版启动后，在开发机终端进入保存compose.yaml的目录，再进入该容器：
docker compose exec ngctl sh
执行用户管理操作前，在容器中以root登录 Meta 服务。使用ngctl auth passwd修改密码无需提前登录，见修改用户密码。
将<root-password>替换为悦数图数据库开发版当前的root密码；首次部署密码的设置和转义规则见设置 root 密码：
ngctl auth login -H graph-cluster -P 9559 -u root -p '<root-password>'
graph-cluster是容器网络中的地址。登录后，在同一个容器中执行管理命令，例如：
ngctl user show
执行exit可返回开发机终端。后续再次进入同一个容器时，登录令牌仍可使用；容器重建后需重新登录。用户管理的完整步骤见用户管理。
下载独立安装包¶
配套 Docker Compose 已包含ngctl容器。需要在开发机或其他机器上直接运行客户端时，可下载独立安装包。
当前版本：5.3.1。按客户端所在机器的操作系统和 CPU 架构选择安装包。
| 操作系统 | CPU 架构 | 安装包 | 校验文件 |
|---|---|---|---|
| macOS | Apple 芯片（ARM64） | 下载 | SHA-256 |
| macOS | Intel（x86-64） | 下载 | SHA-256 |
| Linux | ARM64 | 下载 | SHA-256 |
| Linux | x86-64 | 下载 | SHA-256 |
| Windows | x86-64 | 下载 | SHA-256 |
需要检查文件完整性时，见校验安装包。
解压并连接¶
确认悦数图数据库开发版已按部署教程启动，再在安装包所在目录打开终端。运行下方命令前，将<package-name>替换为下载的文件名。将<root-password>替换为当前的root密码。
默认连接本机的127.0.0.1:9559。从其他机器连接时，将127.0.0.1改为运行 Docker 的开发机 IP；如已修改端口映射，使用修改后的开发机端口。
tar -xzf "<package-name>"
cd yueshu-graph-ngctl/bin
./ngctl auth login -H 127.0.0.1 -P 9559 -u root -p '<root-password>'
tar -xzf "<package-name>"
Set-Location yueshu-graph-ngctl/bin
.\ngctl.exe auth login -H 127.0.0.1 -P 9559 -u root -p '<root-password>'
登录成功后，在同一bin目录中运行管理命令，例如./ngctl user show；Windows PowerShell 使用.\ngctl.exe user show。
命令参考¶
以下主题介绍 ngctl 支持的命令：
Note
命令参考使用ngctl作为可执行文件名。在上述容器中可直接运行；独立安装后，在bin目录中使用./ngctl，Windows PowerShell 使用.\ngctl.exe。
运行ngctl -h可查看命令和参数说明。