跳转至

命令行工具

GoGraph 提供了一个功能丰富且开箱即用的命令行工具(CLI),您可以利用它快速连接到本地图数据库、执行 Cypher 语句,并以直观的表格形式查看数据结果。

1. 安装

方式 A:使用 Homebrew (推荐)

macOS / Linux:

brew install dotnetage/tap/gograph

方式 B:从源码编译 (面向开发人员)

在项目根目录下执行:

make build
编译生成的二进制文件位于 bin/gograph

2. 基础命令结构

CLI 默认开启交互式终端(TUI)。

gograph [database_path]
  • 不带参数运行:打开 default.db 并进入交互模式。
  • 指定数据库路径gograph ./mygraph.db

命令行模式 (非交互式)

如果您希望在 Shell 脚本中调用 GoGraph,可以使用以下子命令:

2.1 数据修改 (exec)

gograph exec "CREATE (n:Person {name: 'Alice'})"

2.2 数据查询 (query)

gograph query "MATCH (n:Person) RETURN n.name"

3. 交互式终端界面 (TUI 模式)

TUI 是日常调试、查询探索的最佳工具,提供 REPL(Read-Eval-Print Loop)环境。

3.1 核心特性

  • ASCII 艺术 Banner:启动时展示版本与版权信息。
  • 自动路由:直接键入 Cypher 语句,系统会自动识别并执行。
  • 自动补全:按下 TAB 键补全关键字。
  • 表格渲染:查询结果以美观的 ASCII 表格呈现。

3.2 TUI 内部指令

指令 说明
/help 打印可用指令帮助
/exit 安全退出 TUI
/query <cypher> 强制以查询模式执行
/exec <cypher> 强制以变更模式执行