qatlas-cli — QuantumAtlas 的命令行客户端
QuantumAtlas 的
qatlas命令行客户端:面向用户侧的论文获取、贡献上传、 本地解析等工作流,通过 HTTP 与服务端 qatlasd 交互。本仓库是主仓 QuantumAtlas 拆出的独立私有仓库,只保留客户端与本地工具,不含服务端代码。
所有服务端通信都是 requests 直发的 HTTP 调用,无重量级 SDK 依赖。
安装
安装方式变更:本包拆分自主仓的
quantum-atlasPython 包(0.21.0a3 起 CLI 不再随主包发布)。PyPI 包名由quantum-atlas改为qatlas-cli, 版本号从 0.21.0a3 延续(首个独立发布为 0.22.0)。之前用uv tool install quantum-atlas安装的用户,改用下面的命令即可, 已有配置(~/.config/qatlas/config.yaml、PAT 等)不受影响。
从 PyPI 安装为全局 CLI 工具(推荐,与拆分前 quantum-atlas 的安装方式一致):
# 推荐:uv 全局工具(隔离环境 + 升级方便)
uv tool install qatlas-cli
# 或 pipx
pipx install qatlas-cli
# 或 plain pip
pip install qatlas-cli
qatlas --help
也可以直接从 GitHub 安装:
uv tool install --from git+ssh://git@github.com/IAI-USTC-Quantum/qatlas-cli.git qatlas-cli
本地 editable 安装(开发用):
git clone git@github.com:IAI-USTC-Quantum/qatlas-cli.git
cd qatlas-cli
uv sync --extra dev # 项目内 .venv,editable 安装本包
# 或装入当前环境:
uv pip install -e .
命令概览
qatlas config # 管理用户级配置文件(~/.config/qatlas/config.yaml)
qatlas auth # 管理各 host 的 PAT / session token(login / status / token / logout)
qatlas paper # 从服务端拉取论文 markdown / 图片 zip(静默 fetch + LRO 轮询;PDF 交付已在服务端停用)
qatlas contrib # 贡献者工作流:上传 PDF(contrib pdf)或本地跑 MinerU 再推送(contrib mineru)
qatlas parser # 抓取并解析 arXiv 论文(本地工作区命令)
别名:papers → paper,parse → parser。
qatlas auth login # 设备码 / PAT 登录
qatlas paper get markdown quant-ph/9508027 --output paper.md
qatlas contrib pdf quant-ph/9508027v1 --pdf paper.pdf
qatlas contrib mineru 2501.00010v1
search 命令由独立插件 qatlas-search 提供(仓库 IAI-USTC-Quantum/qatlas-search),
未安装时 qatlas search 会给出安装提示。
插件机制
第三方包可以通过 entry point 组 qatlas.plugins 注册插件,向 CLI 贡献
顶层命令或 contrib 子命令。插件协议(基类 QatlasPlugin 与
CommandSpec)定义在 qatlas/client/plugins/base.py:
# 插件包自己的 pyproject.toml
[project.entry-points."qatlas.plugins"]
myplugin = "my_package.qatlas_plugin:plugin"
内置命令优先于插件命令;插件不可用时会被静默跳过,不影响 CLI 本体。
版本与兼容性
qatlas-cli 与服务端 qatlasd 各自独立演进版本号,兼容契约是:
两者的
(major, minor)相同即兼容,patch 位随意漂移。 兼容性修复只 bump patch,例如 qatlasd0.22.4↔ qatlas-cli0.22.3是 受支持的配对;而0.23.x服务端配0.22.x客户端则不兼容。
运行行为:CLI 每个请求带 X-Qatlas-Client-Version 头,服务端响应带
X-Qatlas-Server-Version 头,客户端据此比较:
(major, minor)一致:静默通过(patch 差异不算事);- 服务端更新且为写操作:硬失败(exit code 4),提示
uv tool upgrade qatlas-cli; - 服务端更新且为读操作:stderr 警告一次,继续执行;
- 客户端更新:stderr 警告一次(提示运维方升级 qatlasd),继续执行;
- 响应无版本头(0.8.0 之前的老服务端):跳过协商。
完整策略见主仓文档: QuantumAtlas 版本与兼容策略。
配置
用户级配置位于 ~/.config/qatlas/config.yaml(首次运行非 config 命令时
自动创建),顶层 server_url / token 等字段供各客户端命令读取。环境变量
QATLAS_* 系列可覆盖对应配置;QATLAS_SKIP_DOTENV=1 跳过仓库 .env 加载。
开发与测试
uv sync --extra dev
uv run pytest -q # 默认全离线;真打外网的用例标了 network,需 -m network 显式开启
测试覆盖:CLI 命令分发与版本解析、auth(设备码登录 / token 存储,mock HTTP)、
paper / contrib / config 命令行为(mock 服务端)、parser 的 arXiv 抓取与
MinerU 客户端(固定 fixture / mock)。带 network 标记的 live 用例默认跳过。
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qatlas_cli-0.22.1.tar.gz.
File metadata
- Download URL: qatlas_cli-0.22.1.tar.gz
- Upload date:
- Size: 130.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4a36c7348fb243d66e80d758e61b7a83636dd23809965d397f3221ebea415e3
|
|
| MD5 |
c8d910087dfd0679a55eaf7d2cefed7b
|
|
| BLAKE2b-256 |
8462c9110c610f231d9750a7e972caa4ef94c986929f4c13d26adde735c13870
|
Provenance
The following attestation bundles were made for qatlas_cli-0.22.1.tar.gz:
Publisher:
release.yml on IAI-USTC-Quantum/qatlas-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qatlas_cli-0.22.1.tar.gz -
Subject digest:
e4a36c7348fb243d66e80d758e61b7a83636dd23809965d397f3221ebea415e3 - Sigstore transparency entry: 2585838924
- Sigstore integration time:
-
Permalink:
IAI-USTC-Quantum/qatlas-cli@20f2146c9decb5a85d3609a3126aa0c3c68cffb9 -
Branch / Tag:
refs/tags/v0.22.1 - Owner: https://github.com/IAI-USTC-Quantum
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@20f2146c9decb5a85d3609a3126aa0c3c68cffb9 -
Trigger Event:
push
-
Statement type:
File details
Details for the file qatlas_cli-0.22.1-py3-none-any.whl.
File metadata
- Download URL: qatlas_cli-0.22.1-py3-none-any.whl
- Upload date:
- Size: 74.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
976c2ec720d775541d3be3884abf3c9e338a2f7c1dfb8a51faf902581d33f1bc
|
|
| MD5 |
2f850209b7bcd8e860d9ebacf827e06c
|
|
| BLAKE2b-256 |
09e92ace1b3abe9e5aebd9cee1a7ab622d4b9cd542d099b372134999324ec357
|
Provenance
The following attestation bundles were made for qatlas_cli-0.22.1-py3-none-any.whl:
Publisher:
release.yml on IAI-USTC-Quantum/qatlas-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qatlas_cli-0.22.1-py3-none-any.whl -
Subject digest:
976c2ec720d775541d3be3884abf3c9e338a2f7c1dfb8a51faf902581d33f1bc - Sigstore transparency entry: 2585839076
- Sigstore integration time:
-
Permalink:
IAI-USTC-Quantum/qatlas-cli@20f2146c9decb5a85d3609a3126aa0c3c68cffb9 -
Branch / Tag:
refs/tags/v0.22.1 - Owner: https://github.com/IAI-USTC-Quantum
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@20f2146c9decb5a85d3609a3126aa0c3c68cffb9 -
Trigger Event:
push
-
Statement type: