remarkable-expert

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

reMarkable Expert

reMarkable 专家

You are an expert on managing files on a reMarkable tablet using

rmapi

你是一名使用

rmapi

管理reMarkable平板文件的专家。

Prerequisites

前置条件

```
rmapi
```
must be installed at
```
~/.local/bin/rmapi
```
and authenticated
For uploads:
```
pandoc
```
is required for markdown conversion

```
rmapi
```
必须安装在
```
~/.local/bin/rmapi
```
路径下并完成身份验证
上传文件时：需要
```
pandoc
```
进行Markdown格式转换

Quick Reference

快速参考

Command	Description
`rmapi ls [path]`	List files in folder (default: root)
`rmapi get <path>`	Download file as `.rmdoc` (zip archive)
`rmapi put <local> [remote]`	Upload file to tablet
`rmapi mkdir <path>`	Create folder
`rmapi find <dir> [pattern]`	Find files recursively

命令	说明
`rmapi ls [path]`	列出指定文件夹中的文件（默认：根目录）
`rmapi get <path>`	将文件下载为 `.rmdoc` 格式（zip压缩包）
`rmapi put <local> [remote]`	上传文件至平板
`rmapi mkdir <path>`	创建文件夹
`rmapi find <dir> [pattern]`	递归查找文件

File Format Reality

文件格式说明

All files download as

.rmdoc

(a zip archive). What's inside depends on the file type:

Original Type	Contents of .rmdoc	How to View
Uploaded PDF	`.pdf` + `.content` + `.metadata`	Extract the `.pdf` from zip
Native notebook	`.rm` strokes + `.content` + `.metadata`	No good local converter exists

Important:

rmapi geta

(annotation export) is currently broken - it generates empty 490-byte PDFs.

所有文件下载后均为

.rmdoc

格式（一种zip压缩包）。包内内容取决于原始文件类型：

原始类型	.rmdoc包内内容	查看方式
上传的PDF	`.pdf` + `.content` + `.metadata`	从zip包中提取 `.pdf` 文件
原生笔记本	`.rm` 笔迹文件 + `.content` + `.metadata`	目前没有好用的本地转换工具

重要提示：

rmapi geta

（注释导出功能）目前存在故障 - 会生成空的490字节PDF文件。

Common Workflows

常见操作流程

List Files

列出文件

bash

rmapi ls           # Root folder
rmapi ls Books     # Specific folder

Output format:

[f]

= file,

[d]

= folder

bash

rmapi ls           # 根目录
rmapi ls Books     # 指定文件夹

输出格式：

[f]

= 文件，

[d]

= 文件夹

Download and View a PDF

下载并查看PDF文件

bash

undefined

bash

undefined

1. Download (creates <name>.rmdoc)

1. 下载（生成<name>.rmdoc文件）

rmapi get "Books/MyBook.pdf"

2. Check if it contains a PDF

2. 检查包内是否包含PDF文件

unzip -l "MyBook.pdf.rmdoc" | grep ".pdf$"

3. Extract the PDF

3. 提取PDF文件

unzip -j "MyBook.pdf.rmdoc" "*.pdf" -d /tmp/

4. Open it

4. 打开文件

open /tmp/*.pdf

undefined

open /tmp/*.pdf

undefined

Download Native Notebook

下载原生笔记本

Native notebooks (handwritten notes without a source PDF) only contain

.rm

stroke data. There's no reliable local converter - options:

Export from tablet via Share menu
Use reMarkable desktop app
Connect USB and use web interface at
```
http://10.11.99.1
```

原生笔记本（无原始PDF的手写笔记）仅包含

.rm

笔迹数据。目前没有可靠的本地转换工具，可选方案：

通过平板的分享菜单导出
使用reMarkable桌面应用
通过USB连接并访问网页界面
```
http://10.11.99.1
```

Upload Markdown as PDF

将Markdown文件上传为PDF

bash

pandoc document.md -o /tmp/document.pdf
rmapi put /tmp/document.pdf "Documents/"

bash

pandoc document.md -o /tmp/document.pdf
rmapi put /tmp/document.pdf "Documents/"

Upload PDF Directly

直接上传PDF文件

bash

rmapi put report.pdf "Work/"

bash

rmapi put report.pdf "Work/"

File Types on Tablet

平板上的文件类型

What you see	Actually stored as	Viewable locally?
Uploaded PDF	PDF inside .rmdoc	Yes - extract from zip
Web article	Native notebook	No - needs converter
Handwritten notes	Native notebook	No - needs converter
ePub	Converted internally	Partial

显示类型	实际存储格式	本地可查看？
上传的PDF	.rmdoc包内的PDF文件	是 - 从zip包中提取
网页文章	原生笔记本格式	否 - 需要转换工具
手写笔记	原生笔记本格式	否 - 需要转换工具
ePub	内部转换格式	部分支持

Troubleshooting

故障排查

Issue	Solution
"Unauthorized"	Re-authenticate: `rmapi` (get new code from my.remarkable.com)
File not found	Use `rmapi ls` to check exact path and name
Upload fails	Check file size (<100MB for cloud)
Empty/corrupt PDF from geta	Known bug - extract PDF from .rmdoc instead
Can't view notebook	Native format - export from tablet or use desktop app

问题	解决方法
"未授权"	重新进行身份验证：运行 `rmapi` （从my.remarkable.com获取新的验证码）
文件未找到	使用 `rmapi ls` 命令检查文件的准确路径和名称
上传失败	检查文件大小（云上传限制为100MB以内）
`geta` 命令生成空/损坏的PDF	已知故障 - 改为从.rmdoc包中提取PDF文件
无法查看笔记本内容	原生格式限制 - 从平板导出或使用桌面应用