Source: https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngctl/
Documentation version: v5.3.2

# 什么是 ngctl

ngctl 是用于管理悦数图数据库开发版 Meta 服务的命令行工具，可用于登录和登出 Meta 服务、修改用户密码以及管理用户。

## 使用场景

ngctl 可用于以下场景：

- 首次[使用 Docker Compose 部署悦数图数据库开发版](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/)时，ngctl 会自动设置密码并初始化默认服务组。
- [登录 Meta 服务](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngctl/meta-commands/#log_in_to_meta)以获取 Meta 访问令牌。
- 在 Meta 服务中[管理用户](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authentication/manage-users/)。
- [配置会话无状态模式](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authentication/sessionless/)，该模式需要登录 Meta 服务。

## 在 Docker Compose 部署中运行

配套的`compose.yaml`会启动`ngctl`容器。悦数图数据库开发版启动后，在开发机终端进入保存`compose.yaml`的目录，再进入该容器：

````
docker compose exec ngctl sh

````

执行用户管理操作前，在容器中以`root`登录 Meta 服务。使用`ngctl auth passwd`修改密码无需提前登录，见[修改用户密码](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngctl/meta-commands/#change_meta_password)。

将`<root-password>`替换为悦数图数据库开发版当前的`root`密码；首次部署密码的设置和转义规则见[设置 root 密码](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/#root-password)：

````
ngctl auth login -H graph-cluster -P 9559 -u root -p '<root-password>'

````

`graph-cluster`是容器网络中的地址。登录后，在同一个容器中执行管理命令，例如：

````
ngctl user show

````

执行`exit`可返回开发机终端。后续再次进入同一个容器时，登录令牌仍可使用；容器重建后需重新登录。用户管理的完整步骤见[用户管理](https://dev-docs.yueshu.com.cn/v5.3.2/server-admin/authentication/manage-users/)。

## 下载独立安装包

配套 Docker Compose 已包含`ngctl`容器。需要在开发机或其他机器上直接运行客户端时，可下载独立安装包。

当前版本：5.3.1。按客户端所在机器的操作系统和 CPU 架构选择安装包。

 | 操作系统 | CPU 架构 | 安装包 | 校验文件
 | macOS | Apple 芯片（ARM64） | [下载](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-darwin-aarch64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-darwin-aarch64.tgz.sha256sum.txt)
 | macOS | Intel（x86-64） | [下载](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-darwin-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-darwin-x86_64.tgz.sha256sum.txt)
 | Linux | ARM64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-linux-aarch64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-linux-aarch64.tgz.sha256sum.txt)
 | Linux | x86-64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-linux-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-linux-x86_64.tgz.sha256sum.txt)
 | Windows | x86-64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-windows-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngctl/5.3.1/yueshu-graph-ngctl-5.3.1-windows-x86_64.tgz.sha256sum.txt)

需要检查文件完整性时，见[校验安装包](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/#verify-download)。

### 解压并连接

确认悦数图数据库开发版已按[部署教程](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/)启动，再在安装包所在目录打开终端。运行下方命令前，将`<package-name>`替换为下载的文件名。将`<root-password>`替换为当前的`root`密码。

默认连接本机的`127.0.0.1:9559`。从其他机器连接时，将`127.0.0.1`改为运行 Docker 的开发机 IP；如已修改端口映射，使用修改后的开发机端口。

Linux / macOSWindows PowerShell

````
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`。

- [Meta 服务命令](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngctl/meta-commands/)

运行`ngctl -h`可查看命令和参数说明。