Back to Details

skroll

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Skroll

Skroll

Skroll is a browser-canvas presentation tool. This skill drives it through the official CLI, which uses the same OAuth login as the MCP server.
Skroll是一款基于浏览器画布的演示文稿工具。本技能通过官方CLI驱动它运行，该CLI使用与MCP服务器相同的OAuth登录方式。

Setup

安装配置

Needs Node.js 22+.
If you cannot open a browser (headless agent, CI, container), do not run 
login
— it waits five minutes for a browser callback and then times out. Ask the user for an API key from https://skrollai.com/app/settings/integrations and export it:
bash
export SKROLL_API_KEY=sk_…      # or SKROLL_TOKEN=<OAuth access token>
If a browser is available, log in once (PKCE, no API key needed), then confirm:
bash
npx @skrollai/cli login
npx @skrollai/cli whoami
A first-time user is signed up and given an organization automatically during 
login
; there is nothing to set up in the web app first.
Default origin is 
https://skrollai.com
. Override with 
--origin
or 
SKROLL_ORIGIN
for local or self-hosted instances — log in once per origin, since a stored credential is only ever sent to the host that issued it. 
--token
/ 
SKROLL_TOKEN
works against any origin.
需要Node.js 22或更高版本。
如果无法打开浏览器（无头Agent、CI、容器环境），请勿运行
login
命令——它会等待五分钟的浏览器回调，之后超时。请用户从https://skrollai.com/app/settings/integrations获取API密钥并导出：
bash
export SKROLL_API_KEY=sk_…      # or SKROLL_TOKEN=<OAuth access token>
如果可以打开浏览器，登录一次（采用PKCE方式，无需API密钥），然后确认：
bash
npx @skrollai/cli login
npx @skrollai/cli whoami
首次用户在
login
过程中会自动注册并获得一个组织；无需先在网页应用中进行任何设置。
默认源为
https://skrollai.com
。对于本地或自托管实例，可使用
--origin
参数或
SKROLL_ORIGIN
环境变量覆盖——每个源需要登录一次，因为存储的凭据只会发送给颁发它的主机。
--token
参数/
SKROLL_TOKEN
环境变量适用于任何源。

Commands

命令

The CLI maps 1:1 to the Skroll MCP tools (plus 
download_export
, which writes a file). Run 
npx @skrollai/cli help
for flags.
TaskCommand
List decks
npx @skrollai/cli list_decks
(add 
--scope org
for the whole organization; default is your own)
Create a blank deck
npx @skrollai/cli create_deck --title "Q3 review"
(add 
--format webpage
for a scrolling page instead of 16:9 slides, 
--brand-id <id>
to style it)
Generate from a brief
npx @skrollai/cli generate_deck --id <deckId> --mode create --brief "Series A pitch for Acme"
Inspect a deck
npx @skrollai/cli get_deck --id <deckId>
Patch title or visibility
npx @skrollai/cli update_deck --id <deckId> --title "New title"
Replace canvas source
npx @skrollai/cli set_deck_content --id <deckId> --source @deck.tsx
Natural-language edit
npx @skrollai/cli edit_deck --id <deckId> --instruction "Make slide 2 a comparison"
Delete a deck
npx @skrollai/cli delete_deck --id <deckId>
Versions
list_deck_versions
, 
get_deck_version
, 
revert_deck_version
Export PDF / PPTX
create_export --id <deckId> --format pdf
then 
get_export --id <exportId>
Download the file
download_export --id <exportId> --out ./deck.pdf
Brands
list_brands
, 
get_brand
, 
create_brand_from_url --url https://…
, 
delete_brand
Sign out
npx @skrollai/cli logout
Commands print the raw API payload. Prefix a flag value with 
@
to read it from a file.
generate_deck
, 
edit_deck
and 
create_brand_from_url
run synchronously and can take one to three minutes. 
create_export
is asynchronous: poll 
get_export
until status is 
completed
, then 
download_export
.
CLI与Skroll MCP工具一一对应（新增了
download_export
命令用于写入文件）。运行
npx @skrollai/cli help
查看参数。
任务命令
列出演示文稿
npx @skrollai/cli list_decks
（添加
--scope org
参数可查看整个组织的内容；默认仅查看个人内容）
创建空白演示文稿
npx @skrollai/cli create_deck --title "Q3 review"
（添加
--format webpage
参数可创建滚动页面而非16:9幻灯片，添加
--brand-id <id>
参数可设置品牌样式）
根据简介生成演示文稿
npx @skrollai/cli generate_deck --id <deckId> --mode create --brief "Series A pitch for Acme"
查看演示文稿详情
npx @skrollai/cli get_deck --id <deckId>
修改标题或可见性
npx @skrollai/cli update_deck --id <deckId> --title "New title"
替换画布源内容
npx @skrollai/cli set_deck_content --id <deckId> --source @deck.tsx
自然语言编辑
npx @skrollai/cli edit_deck --id <deckId> --instruction "Make slide 2 a comparison"
删除演示文稿
npx @skrollai/cli delete_deck --id <deckId>
版本控制
list_deck_versions
, 
get_deck_version
, 
revert_deck_version
导出PDF/PPTX先执行
create_export --id <deckId> --format pdf
，再执行
get_export --id <exportId>
下载导出文件
download_export --id <exportId> --out ./deck.pdf
品牌管理
list_brands
, 
get_brand
, 
create_brand_from_url --url https://…
, 
delete_brand
退出登录
npx @skrollai/cli logout
命令会打印原始API负载。参数值前缀加
@
表示从文件读取。
generate_deck
、
edit_deck
和
create_brand_from_url
命令同步运行，可能需要1到3分钟。
create_export
是异步的：轮询
get_export
命令直到状态变为
completed
，然后执行
download_export
。

Errors worth handling

值得处理的错误

Every failure is JSON: 
{"error":{"code":…,"message":…}}
. Three are worth reacting to rather than retrying:
  • 402 
    payment_required
     — the organization has used its free allowance (10 skrolls, 100 edits). Retrying will never succeed. Tell the user, and point them at https://skrollai.com/app/settings/billing.
  • 429 
    rate_limited
     — back off for the 
    retryAfterSeconds
    in the response. 
    generate_deck
    , 
    edit_deck
    , 
    create_brand_from_url
    and 
    create_export
    share a budget of 10 per minute; everything else is 120 per minute.
  • 401 
    unauthorized
     — the session expired or was revoked. Run 
    login
    again, or check 
    SKROLL_API_KEY
    .
所有失败都会返回JSON格式：
{"error":{"code":…,"message":…}}
。有三种错误值得处理而非重试：
  • 402 
    payment_required
     —— 组织已用完免费额度（10个Skroll演示文稿，100次编辑）。重试不会成功。告知用户，并引导他们访问https://skrollai.com/app/settings/billing。
  • 429 
    rate_limited
     —— 根据响应中的
    retryAfterSeconds
    值进行退避等待。
    generate_deck
    、
    edit_deck
    、
    create_brand_from_url
    和
    create_export
    命令共享每分钟10次的限额；其他命令限额为每分钟120次。
  • 401 
    unauthorized
     —— 会话已过期或被撤销。重新运行
    login
    命令，或检查
    SKROLL_API_KEY
    是否正确。

Sharing

共享功能

Public viewer URLs look like 
https://skrollai.com/d/f4zqohxo7d
. After 
update_deck --visibility public
, share the 
publicUrl
field from the JSON. 
get_deck
and 
list_decks
return the same field when the skroll is public. Never invent a share link from the deck id, title, or API path.
公共查看器URL格式为
https://skrollai.com/d/f4zqohxo7d
。执行
update_deck --visibility public
后，分享JSON中的
publicUrl
字段。当Skroll演示文稿设为公开时，
get_deck
和
list_decks
命令会返回相同的字段。切勿根据演示文稿ID、标题或API路径自行生成共享链接。

Docs

文档链接