/install alist-cli
AList CLI
- Author: LeeShunEE
- Organization: KinemaClawWorkspace
- GitHub: https://github.com/KinemaClawWorkspace/alist-cli
AList file management CLI. Auth token managed via environment variables with auto-login and auto-refresh.
⚠️ Before First Use | 首次使用必读
首次使用此 skill 前,必须先读取 ONBOARDING.md 完成环境配置。
- 环境不可用(命令不存在、依赖缺失、连接失败)→ 读取 ONBOARDING.md 按步骤排查修复
- 首次配置 → 读取 ONBOARDING.md 完成 6 步配置
- 配置完成后 → 直接使用下方 Run Commands
Environment Variables
| Variable | Required | Description |
|---|---|---|
ALIST_URL |
✅ | AList server URL (e.g. https://your-alist-server) |
ALIST_USERNAME |
✅ | Login username |
ALIST_PASSWORD |
✅ | Login password |
ALIST_AUTH_TOKEN |
❌ | Auth token (auto-obtained via login, skip manual set) |
ALIST_USER_INFO |
❌ | User info JSON (auto-obtained via login, skip manual set) |
Run Commands
alist-cli \x3Ccommand> [args]
Commands
| Command | Description |
|---|---|
login [username] [password] |
Login (outputs export statements to source) |
ls [path] |
List files |
get \x3Cpath> |
Get file info + all URLs |
url \x3Cpath> |
Get preview/download URLs for file or folder |
mkdir \x3Cpath> |
Create folder |
upload \x3Clocal> \x3Cremote> |
Upload file (outputs preview + download URL) |
rm \x3Cpath> |
Delete file |
mv \x3Csrc> \x3Cdst> |
Move file |
search \x3Ckeyword> [path] |
Search files |
whoami |
Current user info |
Upload Behavior | 上传行为
上传前必须判断文件用途,选择正确的目标路径:
判断规则
| 场景 | 目标路径 | 说明 |
|---|---|---|
| 外部访问(分享给他人、公开文件) | /public/... |
Guest 可见,预览和下载链接无需登录 |
| 内部使用(个人文件、工具输出、临时文件) | /private/storage/... |
需要登录才能访问 |
如何判断:
- 用户明确说"分享给 XX"、"发给别人"、"外部" →
/public/ - 用户说"内部"、"私有"、"自己看"、"备份" →
/private/storage/ - 用户未说明 → 必须询问文件用途
- 批量上传多个文件到同一个目标 → 可以创建新文件夹整理
- 单个文件 → 一般直接上传到已有目录,不新建文件夹(除非用户指定或目标目录为空)
文件夹创建规则
- ❌ 不要随意创建新文件夹
- ✅ 用户明确要求时才创建
- ✅ 批量上传且目标目录为空时,可以创建子文件夹
- ✅ 用户指定路径时,自动创建(mkdir -p 行为由 API 保证)
URL Rules
AList 文件有两种链接:
1. 预览链接
{ALIST_URL}{path}
- 从 raw_url 去掉
/p前缀和?sign=xxx参数 - 内部文件(
/private/):需要 AList 登录态才能预览 - 外部文件(
/public/):无需登录即可预览 - 例:
https://cloud.example.com/public/docs/notes.md
2. 下载直链
API 返回的 raw_url 字段(包含 /p/ 前缀和 ?sign 签名)
- 直接下载文件,无需登录,curl/wget 可用
- 签名有时效性,过期后需重新通过 API 获取
- 例:
https://cloud.example.com/p/public/docs/notes.md?sign=abc123=:0 - 分享文件时优先使用此链接
Directory Structure | 目录结构
/ (root)
├── public/ ← 外部访问(guest 挂载点)
│ └── ...
└── private/ ← 内部文件(需登录)
└── storage/ ← 用户存储
└── ...
Path Mapping
user_path (用户输入) → real_path (AList API 使用)
/public/docs/a.md → /public/docs/a.md (外部)
/private/storage/a → /private/storage/a (内部)
base_path通过登录自动获取(/api/me接口),当前为/- 预览链接基于
real_path(去掉/p和?sign) - 下载直链使用 API 返回的
raw_url
Auth Behavior
- Auto-login: Script checks
ALIST_AUTH_TOKENon startup. If missing, auto-logins withALIST_USERNAME+ALIST_PASSWORD. - Auto-refresh: If API returns 401, automatically re-logins and retries.
- Manual login:
alist logincommand outputsexportstatements. User shouldeval $(alist login)or manuallysourcethem.
References
references/openapi.json- AList API specification
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install alist-cli - After installation, invoke the skill by name or use
/alist-cli - Provide required inputs per the skill's parameter spec and get structured output
What is AList CLI (Cloud Storage CLI for AList)?
AList file management CLI for OpenClaw. Supports upload, download, list, mkdir, rm, mv, search, url. Auth via environment variables with auto-refresh. Trigge... It is an AI Agent Skill for Claude Code / OpenClaw, with 247 downloads so far.
How do I install AList CLI (Cloud Storage CLI for AList)?
Run "/install alist-cli" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is AList CLI (Cloud Storage CLI for AList) free?
Yes, AList CLI (Cloud Storage CLI for AList) is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does AList CLI (Cloud Storage CLI for AList) support?
AList CLI (Cloud Storage CLI for AList) is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created AList CLI (Cloud Storage CLI for AList)?
It is built and maintained by Kinema. (@leeshunee); the current version is v1.6.2.