remarkable-axi

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

remarkable-axi

An AXI CLI for the reMarkable cloud. No install needed — every command below runs as

npx -y remarkable-axi …

. Run it bare first to see current pairing status and what's on the tablet:

npx -y remarkable-axi

If it reports

NOT_AUTHENTICATED

, pair with an 8-character code from https://my.remarkable.com/device/desktop/connect:

npx -y remarkable-axi login <code>

一款面向reMarkable云的AXI CLI工具。无需安装——以下所有命令均以

npx -y remarkable-axi …

的形式运行。先直接运行该命令，查看当前配对状态及平板上的内容：

npx -y remarkable-axi

如果显示

NOT_AUTHENTICATED

，请使用https://my.remarkable.com/device/desktop/connect上的8位配对码进行配对：

npx -y remarkable-axi login <code>

。

The design → send → pull loop

设计 → 发送 → 拉取流程

Design against the panel, not a monitor — get the page box and a CSS block to author against:
```
npx -y remarkable-axi page --css
```
.
Check before sending — rasterize at the device's density and lint hairlines, contrast, type size, and page box:
```
npx -y remarkable-axi check flyer.html
```
.

Send —

npx -y remarkable-axi put flyer.html "/Talks"

. Replacing an inked document refuses by default; see

put --help

for

--replace

and

--discard-ink

Pull ink back —
```
npx -y remarkable-axi get "/Talks/Flyer" --overlay
```
for annotations drawn over the original, or
```
--as text
```
for OCR'd text.

针对平板屏幕而非显示器进行设计——获取页面尺寸框及用于创作的CSS代码块：
```
npx -y remarkable-axi page --css
```
。
发送前检查——以设备分辨率栅格化内容，并检查细线、对比度、字体大小及页面尺寸：
```
npx -y remarkable-axi check flyer.html
```
。
发送文件——
```
npx -y remarkable-axi put flyer.html "/Talks"
```
。默认情况下，替换带有墨迹的文档会被拒绝；如需替换，可查看
```
put --help
```
了解
```
--replace
```
和
```
--discard-ink
```
参数。
拉取墨迹内容——若要获取覆盖在原文档上的批注，使用
```
npx -y remarkable-axi get "/Talks/Flyer" --overlay
```
；若要获取OCR识别后的文本，使用
```
--as text
```
参数。

Handwriting looks lost — stop and read this first

手写内容看似丢失——请先停止操作并阅读以下内容

"Cloud shows zero ink but I know I wrote something", "the tablet has blank pages that had notes on them", "did that replace eat my annotations" — these are all the same failure: strokes the device hadn't synced up yet, orphaned by a replace or a sync restart that won the cloud's side. They are not destroyed; they are recoverable, but only if nobody touches the tablet before the backup is taken.

Open references/ink-recovery.md now, before opening any document on the device, writing anything, or launching the desktop app. It carries the triage, the hands-off discipline, and the manual SSH recovery procedure — proven end to end in two real incidents.

“云端显示无墨迹但我确定写过内容”、“平板上原本有笔记的页面变成空白”、“替换文档会不会弄丢我的批注”——这些都是同一类问题：设备尚未同步到云端的笔迹，因替换文档或同步重启导致云端覆盖而成为孤立数据。这些内容并未被销毁，仍可恢复，但前提是在完成备份前任何人都不能操作平板。

请立即打开references/ink-recovery.md，在此之前不要打开设备上的任何文档、进行任何书写操作或启动桌面应用。该文档包含分类处理方法、禁止操作规则、备份步骤以及手动SSH恢复流程——已在两起实际事件中全程验证有效。

Reference files

参考文件

references/ink-recovery.md — open when ink or annotations look missing. Triage, the hands-off rule, backup, and the manual SSH reattach procedure.
references/ssh-setup.md — open the first time device recovery is needed and SSH isn't set up yet: enabling SSH on-device, installing a key, direct vs. relayed access.

references/ink-recovery.md——当墨迹或批注丢失时打开此文件。包含分类处理、禁止操作规则、备份及手动SSH重新关联流程。
references/ssh-setup.md——首次需要设备恢复且未设置SSH时打开此文件：包含在设备上启用SSH、安装密钥、直接访问与中继访问的相关说明。

Command reference

命令参考

Design

设计

```
npx -y remarkable-axi page [--device <model>] [--landscape] [--css]
```
— Report the target device's page box, and the CSS to author against it

npx -y remarkable-axi render <html> [--out <path>] [--device <model>] [--landscape] [--device-page]

— Print an HTML document to a PDF sized for the target device's page box

npx -y remarkable-axi check <file> [--pages <spec>] [--device <model>] [--out <dir>] [--full-res] [--no-images]

— Rasterize a PDF or HTML document at the device's density and lint it against the panel

```
npx -y remarkable-axi page [--device <model>] [--landscape] [--css]
```
——报告目标设备的页面尺寸框及用于创作的CSS代码

npx -y remarkable-axi render <html> [--out <path>] [--device <model>] [--landscape] [--device-page]

——将HTML文档打印为适配目标设备页面尺寸的PDF

npx -y remarkable-axi check <file> [--pages <spec>] [--device <model>] [--out <dir>] [--full-res] [--no-images]

——以设备分辨率栅格化PDF或HTML文档，并针对平板屏幕进行检查

Move

传输

```
npx -y remarkable-axi put <src> <dest>
```
— Send a local PDF/EPUB or a URL to the tablet — source first, destination last
```
npx -y remarkable-axi get <path> [<dest>]
```
— Bring a document down off the tablet — rendered ink, typed text, or the original file

```
npx -y remarkable-axi put <src> <dest>
```
——将本地PDF/EPUB文件或URL发送至平板——源在前，目标路径在后
```
npx -y remarkable-axi get <path> [<dest>]
```
——从平板下载文档——包括渲染后的墨迹、键盘输入的文本或原始文件

Browse

浏览

```
npx -y remarkable-axi ls [<path>]
```
— List the contents of a folder (default: /)
```
npx -y remarkable-axi find <pattern>
```
— Search every document and folder name by substring or regex
```
npx -y remarkable-axi devices
```
— Show known reMarkable models with screen specs and PDF page sizes

```
npx -y remarkable-axi ls [<path>]
```
——列出文件夹内容（默认路径：/）
```
npx -y remarkable-axi find <pattern>
```
——通过子串或正则表达式搜索所有文档和文件夹名称
```
npx -y remarkable-axi devices
```
——显示已知的reMarkable型号及其屏幕规格和PDF页面尺寸

Organize

整理

```
npx -y remarkable-axi mkdir <path>
```
— Create a folder and every missing parent (idempotent)
```
npx -y remarkable-axi mv <path> <dest-dir>
```
— Move a document or folder into another folder
```
npx -y remarkable-axi rm <path>
```
— Move a document or folder to the trash

```
npx -y remarkable-axi mkdir <path>
```
——创建文件夹及所有缺失的父文件夹（幂等操作）
```
npx -y remarkable-axi mv <path> <dest-dir>
```
——将文档或文件夹移动至另一个文件夹
```
npx -y remarkable-axi rm <path>
```
——将文档或文件夹移至回收站

Setup

配置

```
npx -y remarkable-axi login <code>
```
— Pair this machine using an 8-character code from my.remarkable.com
```
npx -y remarkable-axi doctor
```
— Check pairing, connectivity, external tools, duplicate paths, and the cache
```
npx -y remarkable-axi setup device <model>
```
— Set the device to design for; its specs then appear in every session
```
npx -y remarkable-axi setup hooks
```
— Install SessionStart hooks so agents see tablet state automatically
```
npx -y remarkable-axi setup ssh <destination> [--via <jump>]
```
— Configure direct or relayed SSH access to the tablet, for the device command group

```
npx -y remarkable-axi login <code>
```
——使用my.remarkable.com上的8位配对码将本机与平板配对
```
npx -y remarkable-axi doctor
```
——检查配对状态、连接性、外部工具、重复路径及缓存
```
npx -y remarkable-axi setup device <model>
```
——设置目标设计设备，其规格将在所有会话中生效
```
npx -y remarkable-axi setup hooks
```
——安装SessionStart钩子，使Agent自动获取平板状态
```
npx -y remarkable-axi setup ssh <destination> [--via <jump>]
```
——配置直接或中继SSH访问平板，用于设备命令组

Device

设备

```
npx -y remarkable-axi device status [--ssh <dest>] [--via <jump>]
```
— Check tablet reachability, xochitl, storage free, and local document count
```
npx -y remarkable-axi device backup <path> [--out <tar>] [--force] [--ssh <dest>] [--via <jump>]
```
— Tar a document's complete on-device file set to a local archive — the first step of every recovery

npx -y remarkable-axi device orphans [<path>] [--render] [--out <dir>] [--ssh <dest>] [--via <jump>]

— List .rm stroke files no page index references — the tablet's own unsynced/clobbered ink

npx -y remarkable-axi device reattach <path> --map <stroke-uuid>=<page-uuid>[,...] | --restore-index [--ssh <dest>] [--via <jump>]

— Write recovered strokes back into a document's index — backup, stop xochitl, write, sync, restart

Every command supports

--help

for its full flag reference and examples.

```
npx -y remarkable-axi device status [--ssh <dest>] [--via <jump>]
```
——检查平板可达性、xochitl服务状态、可用存储空间及本地文档数量
```
npx -y remarkable-axi device backup <path> [--out <tar>] [--force] [--ssh <dest>] [--via <jump>]
```
——将文档在设备上的完整文件集打包为本地归档文件——这是所有恢复操作的第一步
```
npx -y remarkable-axi device orphans [<path>] [--render] [--out <dir>] [--ssh <dest>] [--via <jump>]
```
——列出未被页面索引引用的.rm笔迹文件——即平板自身未同步或被覆盖的墨迹

npx -y remarkable-axi device reattach <path> --map <stroke-uuid>=<page-uuid>[,...] | --restore-index [--ssh <dest>] [--via <jump>]

——将恢复的笔迹写回文档索引——步骤为：备份、停止xochitl服务、写入、同步、重启服务

所有命令均支持

--help

参数，查看完整的标志参考及示例。

Notes

说明

Nothing above is exclusive to this skill — every workflow works from the CLI's own
```
--help
```
and ambient output with no skill installed. This skill adds the recovery judgment and one-time SSH setup that command output alone can't teach.
The
```
device
```
command group (
```
device status
```
,
```
device backup
```
,
```
device orphans
```
,
```
device reattach
```
) is fully shipped. The ink-recovery playbook drives recovery through those commands now; the raw SSH procedure that shipped first is kept in the playbook as a fallback appendix, for a step no command covers or a connection the commands themselves can't reach.

以上所有操作均不依赖本技能——无需安装技能，仅通过CLI自身的
```
--help
```
及输出信息即可完成所有工作流。本技能新增了恢复判断逻辑及一次性SSH设置指导，这些是命令输出无法直接提供的内容。
设备命令组（
```
device status
```
、
```
device backup
```
、
```
device orphans
```
、
```
device reattach
```
）已完全发布。墨迹恢复指南现在通过这些命令驱动恢复流程；最初发布的原始SSH流程作为备用附录保留在指南中，用于处理命令未覆盖的步骤或命令无法连接的场景。