Skip to main content
Glama

Z-CLI

zspace 私有云命令行工具,支持 CLIMCP Server 两种使用方式,提供文件管理、存储池查询等 NAS 操作能力。

功能特性

  • 文件操作 — 列表、创建、重命名、移动、复制、删除(回收站)

  • 目录管理 — 创建文件夹,支持冲突自动重命名

  • 文件搜索 — 按名称/类型/大小/时间搜索,支持分页

  • 存储池查询 — 查看存储池信息和名称映射

  • 最近文件 — 获取最近访问文件列表

  • 通用请求 — 向任意 URL 发送 HTTP 请求

  • MCP Server — 通过 Model Context Protocol 暴露所有能力给 AI 助手

Related MCP server: truenas-ws-mcp

安装

前置条件

  • macOS(认证模块依赖 zspace 桌面客户端,暂不支持其他系统)

  • Python >= 3.10

  • zspace 桌面客户端已安装、登录,并保持在后台运行

安装方式

# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate

# 安装
pip install -e .

# 验证
zcli pool

快速上手

# 查看存储池
./dev pool
./dev poolname

# 文件操作
./dev list /sata12/my/data
./dev mkdir /sata12/my/data 新建文件夹
./dev create /sata12/my/data/文件.txt
./dev rename /sata12/my/data/旧名称 新名称
./dev copy /sata12/my/data/a /sata12/my/data/b
./dev move /sata12/my/data/a /sata12/my/data/sub/
./dev remove /sata12/my/data/无用文件.txt

# 搜索与最近文件
./dev search 关键词
./dev recent

# 通用请求
./dev request get https://api.example.com

# 启动 MCP Server
./dev mcp

开发模式使用 ./dev 脚本(改源码即生效),生产模式使用 zcli 命令。

接入 Agent 示例

将 z-cli 的 MCP Server 接入 AI 助手(如 opencode、Claude Code)后,用户可以通过自然语言直接操控 NAS。

下图为自研的 NAS 助手 Agent:

z-cli 演示

CLI 命令参考

命令

功能

示例

pool

查看存储池信息

zcli pool

poolname

查看存储池名称映射

zcli poolname

list <path>

列出目录文件

zcli list /sata12/my/data

mkdir <parent> <name>

创建文件夹

zcli mkdir /sata12/my/data 新建

create <path>

创建文件

zcli create /sata12/my/data/a.txt

rename <path> <newname>

重命名

zcli rename /sata12/my/data/旧 新

copy <from> <to>

复制

zcli copy /sata12/a /sata12/b

move <from> <to>

移动

zcli move /sata12/a /sata12/b/

remove <path>

删除(回收站)

zcli remove /sata12/my/data/文件.txt

search <keyword>

搜索文件

zcli search 会议记录

recent

最近文件

zcli recent

request <method> <url>

通用 HTTP 请求

zcli request get https://example.com

mcp

启动 MCP Server

zcli mcp

MCP 配置

推荐方式:pipx 全局安装

pipx install -e /path/to/zspace-cli

然后在 opencode.json 中配置:

{
  "mcp": {
    "zspace-cli": {
      "type": "local",
      "command": ["zcli", "mcp"],
      "enabled": true
    }
  }
}

备选方式:项目虚拟环境

opencode.json 中配置:

{
  "mcp": {
    "zspace-cli": {
      "type": "local",
      "command": [".venv/bin/python", "-m", "zspace", "mcp"],
      "enabled": true
    }
  }
}

注意:macOS 可能对 .venv 下的文件自动设置隐藏标志,导致 Python 3.8+ 跳过 __editable__.pth 文件(CPython #113659)。如果遇到 ModuleNotFoundError: No module named 'zspace' 错误,运行以下命令修复:

xattr -rc .venv
chflags -R 0 .venv

MCP 工具列表

工具

功能

get_pool_info

查看存储池信息

get_pool_names

查看存储池名称映射

list_files

列出目录文件

create_folder

创建文件夹

create_file

创建文件

delete_item

删除文件/文件夹(移至回收站)

rename_item

重命名

copy_item

复制

move_item

移动

search_files

搜索文件

list_recent_files

最近文件

make_request

通用 HTTP 请求

存储池路径规则

访问文件路径格式为 /<pool_name>/my/data,其中 pool_namepool 接口返回的 name 字段(如 sata12sata14),不是 id 或系统挂载点。

环境变量

变量

说明

ZSPACE_HOST

覆盖 zspace 本地代理地址,用于跨网络访问

项目结构

z-cli/
├── .github/workflows/      # CI 配置
├── .claude/                # Claude 技能配置
├── src/zspace/
│   ├── api/                # NAS API 层
│   │   ├── fields.py       # 字段映射
│   │   ├── file.py         # 文件操作 API
│   │   └── pool.py         # 存储池 API
│   ├── commands/           # CLI 子命令
│   │   ├── base.py         # Command 基类
│   │   └── ...             # 每个命令一个文件
│   ├── mcp/                # MCP 服务器
│   │   ├── base.py         # McpTool 基类
│   │   └── tools/          # 每个工具一个文件
│   ├── auth.py             # 登录凭据读取
│   └── client.py           # HTTP 客户端封装
├── tests/                  # 测试
├── dev                     # 热更新运行脚本
├── Makefile                # 常用开发命令
├── CHANGELOG.md            # 变更日志
└── CONTRIBUTING.md         # 贡献指南

开发

# 安装开发依赖
pip install -e ".[dev]"

# 热更新模式(改源码即生效)
./dev pool

# 代码检查
make lint

# 运行测试
make test

许可证

MIT

Install Server
A
license - permissive license
B
quality
A
maintenance

Maintenance

Maintainers
Response time
Release cycle
1Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/philipxiaoxi/z-cli'

If you have feedback or need assistance with the MCP directory API, please join our Discord server