Back to Details

neo4j-cli-tools-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Neo4j CLI Tools skill

Neo4j CLI 工具技能

This skill provides comprehensive guidance on Neo4j command-line tools for database administration, query execution, cloud management, and AI agent integration.
本技能提供Neo4j命令行工具的全面指导，可用于数据库管理、查询执行、云资源管理和AI Agent集成等场景。

When to use

适用场景

Use this skill when:
  • Setting up or configuring Neo4j databases via command line
  • Running administrative tasks with neo4j-admin
  • Executing Cypher queries from the command line
  • Managing Neo4j Aura cloud instances
  • Setting up the Neo4j MCP server for AI agents
  • Troubleshooting Neo4j CLI tool issues
  • Migrating or backing up databases using CLI tools
当你需要完成以下操作时可使用本技能：
  • 通过命令行搭建或配置Neo4j数据库
  • 使用neo4j-admin执行管理任务
  • 从命令行执行Cypher查询
  • 管理Neo4j Aura云实例
  • 为AI Agent配置Neo4j MCP服务器
  • 排查Neo4j CLI工具的相关问题
  • 使用CLI工具迁移或备份数据库

Available CLI Tools

支持的CLI工具

1. neo4j-admin

1. neo4j-admin

Purpose: Comprehensive database administration tool
Categories:
  • dbms
    - System-wide administration for single and clustered environments
  • server
    - Server-level management tasks
  • database
    - Database-specific operations (backup, restore, import, migrate)
  • backup
    - Backup and restore operations
Common Use Cases:
  • Database backup and restore
  • Data import and export
  • Server memory recommendations
  • Initial password setup
  • Database health checks
Reference: neo4j-admin-reference.md
用途：全能型数据库管理工具
功能分类：
  • dbms
    - 单实例和集群环境的全系统管理
  • server
    - 服务器层级的管理任务
  • database
    - 数据库专属操作（备份、恢复、导入、迁移）
  • backup
    - 备份与恢复操作
常见使用场景：
  • 数据库备份与恢复
  • 数据导入导出
  • 服务器内存配置建议
  • 初始密码设置
  • 数据库健康检查
参考文档：neo4j-admin-reference.md

2. cypher-shell

2. cypher-shell

Purpose: Interactive command-line tool for executing Cypher queries
Key Features:
  • Interactive REPL for ad-hoc queries
  • Script execution from files
  • Parameterized query support
  • Multiple output formats (verbose, plain, auto)
  • Remote database connections
Common Use Cases:
  • Running Cypher queries from terminal
  • Batch processing with query files
  • Database exploration and debugging
  • CI/CD pipeline integration
  • Scripted data operations
Requirements: Java 21
Reference: cypher-shell-reference.md
用途：用于执行Cypher查询的交互式命令行工具
核心特性：
  • 交互式REPL用于执行即席查询
  • 支持从文件执行脚本
  • 支持参数化查询
  • 多种输出格式（详细、简洁、自动）
  • 支持远程数据库连接
常见使用场景：
  • 从终端运行Cypher查询
  • 通过查询文件实现批量处理
  • 数据库探索和调试
  • CI/CD流水线集成
  • 脚本化数据操作
依赖要求：Java 21
参考文档：cypher-shell-reference.md

3. aura-cli

3. aura-cli

Purpose: Command-line interface for managing Neo4j Aura cloud resources
Key Features:
  • Instance provisioning and management
  • Tenant administration
  • Credential management
  • Graph Analytics operations
  • Customer-managed keys
Common Use Cases:
  • Automating Aura instance creation
  • Managing cloud database lifecycles
  • CI/CD integration for cloud deployments
  • Programmatic resource provisioning
Reference: aura-cli-reference.md
用途：用于管理Neo4j Aura云资源的命令行接口
核心特性：
  • 实例创建与管理
  • 租户管理
  • 凭证管理
  • 图分析操作
  • 客户托管密钥支持
常见使用场景：
  • 自动化创建Aura实例
  • 管理云数据库生命周期
  • 云部署的CI/CD集成
  • 程序化资源调配
参考文档：aura-cli-reference.md

4. neo4j-mcp

4. neo4j-mcp

Purpose: Model Context Protocol server for Neo4j integration with AI agents
Key Features:
  • Enables AI agents to interact with Neo4j
  • Tools for query execution and schema inspection
  • Read-only and read-write modes
  • Multiple transport modes (stdio, http)
  • Works with all Neo4j deployment types
Common Use Cases:
  • Integrating Neo4j with Claude or other AI agents
  • Building AI-powered graph applications
  • Natural language to Cypher translation
  • Automated data analysis workflows
Requirements: Neo4j instance with APOC plugin
Reference: neo4j-mcp-reference.md
用途：用于实现Neo4j与AI Agent集成的模型上下文协议（Model Context Protocol）服务器
核心特性：
  • 支持AI Agent与Neo4j交互
  • 提供查询执行和Schema查看工具
  • 支持只读和读写模式
  • 多种传输模式（stdio、http）
  • 兼容所有Neo4j部署类型
常见使用场景：
  • 对接Neo4j与Claude或其他AI Agent
  • 构建AI驱动的图应用
  • 自然语言转Cypher翻译
  • 自动化数据分析工作流
依赖要求：安装了APOC插件的Neo4j实例
参考文档：neo4j-mcp-reference.md

Instructions

使用指引

When a user asks about Neo4j CLI tools:
  1. Identify the appropriate tool based on the use case:
    • Administration tasks → neo4j-admin
    • Query execution → cypher-shell
    • Cloud management → aura-cli
    • AI agent integration → neo4j-mcp
  2. Check prerequisites:
    • For cypher-shell: Verify Java 21 is installed
    • For neo4j-mcp: Verify APOC plugin is available
    • For aura-cli: Verify credentials are configured
  3. Provide practical examples:
    • Always include actual command syntax
    • Show common parameter combinations
    • Include environment variable alternatives
    • Demonstrate error handling where relevant
  4. Reference detailed documentation:
    • Include the appropriate reference file from 
      references/
      directory
    • Point to official Neo4j documentation for latest updates
    • Mention version-specific considerations
  5. Installation guidance:
    • neo4j-admin and cypher-shell: Included with Neo4j installation
    • aura-cli: Download from GitHub releases
    • neo4j-mcp: Download binary from official repository
    • Include installation verification steps
当用户询问Neo4j CLI工具相关问题时：
  1. 根据使用场景匹配合适的工具：
    • 管理任务 → neo4j-admin
    • 查询执行 → cypher-shell
    • 云资源管理 → aura-cli
    • AI Agent集成 → neo4j-mcp
  2. 检查前置依赖：
    • cypher-shell：确认已安装Java 21
    • neo4j-mcp：确认已安装APOC插件
    • aura-cli：确认凭证已配置
  3. 提供实操示例：
    • 始终包含实际的命令语法
    • 展示常用参数组合
    • 提供环境变量替代方案
    • 必要时演示错误处理方法
  4. 关联详细文档：
    • 提供
      references/
      目录下对应的参考文件
    • 引导用户查阅Neo4j官方文档获取最新更新
    • 提及版本相关的注意事项
  5. 安装指导：
    • neo4j-admin和cypher-shell：随Neo4j安装包默认提供
    • aura-cli：从GitHub Releases下载
    • neo4j-mcp：从官方仓库下载二进制文件
    • 包含安装验证步骤

Important Notes

重要注意事项

  • All commands support 
    --help
    for detailed usage information
  • Configuration priority: CLI flags > environment variables > config files
  • Neo4j 2026.01 is the current version (as of documentation date)
  • Always execute neo4j-admin commands as the Neo4j system user
  • Exit code 0 indicates success; non-zero indicates errors
  • 所有命令都支持
    --help
    参数查看详细使用说明
  • 配置优先级：CLI参数 > 环境变量 > 配置文件
  • 当前文档对应的Neo4j版本为2026.01（文档发布时）
  • 始终以Neo4j系统用户身份执行neo4j-admin命令
  • 退出码0表示执行成功，非0表示出现错误

Environment Variables

环境变量

Common environment variables across tools:
  • NEO4J_URI
    / 
    NEO4J_ADDRESS
    - Database connection URI
  • NEO4J_USERNAME
    - Database username
  • NEO4J_PASSWORD
    - Database password
  • NEO4J_DATABASE
    - Target database name
  • NEO4J_CONF
    - Path to neo4j.conf directory
  • NEO4J_HOME
    - Neo4j installation directory
各工具通用的环境变量：
  • NEO4J_URI
    / 
    NEO4J_ADDRESS
    - 数据库连接URI
  • NEO4J_USERNAME
    - 数据库用户名
  • NEO4J_PASSWORD
    - 数据库密码
  • NEO4J_DATABASE
    - 目标数据库名称
  • NEO4J_CONF
    - neo4j.conf目录路径
  • NEO4J_HOME
    - Neo4j安装目录

Resources

参考资源