outline-skills

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Outline Skills

Outline 技能

Purpose

用途

Use this skill when the user asks to operate an Outline knowledge base via API/CLI.
当用户要求通过API/CLI操作Outline知识库时,使用此技能。

Outline Content Guidance

Outline内容规范

Outline documents support rich, structured content — not just plain paragraphs. When creating or updating documents, actively choose formatting that fits the task: headings, bullet/numbered lists, task lists, tables, quotes, code fences, callouts, links, attachments, and Mermaid diagrams when helpful.
Prefer readable structure over large walls of text. For example:
  • use headings for sections
  • use lists for steps, options, and summaries
  • use tables for comparisons
  • use code fences for commands/snippets
  • use Mermaid for flows, architecture, or state diagrams
Outline文档支持丰富的结构化内容 — 不只是纯文本段落。创建或更新文档时,请主动选择适合任务的格式:标题、项目符号/编号列表、任务列表、表格、引用、代码块、提示框、链接、附件,必要时还可使用Mermaid图表。
优先选择易读的结构,避免大段文本堆砌。例如:
  • 使用标题划分章节
  • 使用列表呈现步骤、选项和摘要
  • 使用表格进行对比
  • 使用代码块展示命令/代码片段
  • 使用Mermaid绘制流程、架构或状态图

When to Trigger

触发时机

Trigger this skill when requests involve:
  • Outline documents or collections
  • knowledge base search
  • users/groups/comments/attachments/file operations
  • share links, stars, revisions, events, or views
当请求涉及以下内容时,触发此技能:
  • Outline文档或集合
  • 知识库搜索
  • 用户/群组/评论/附件/文件操作
  • 分享链接、星标、修订版本、事件或浏览记录

Agent Execution Checklist

Agent执行检查清单

Before running commands:
  1. Confirm the user intent (read vs write vs destructive action).
  2. Confirm required identifiers (
    document-id
    ,
    collection-id
    , etc.).
  3. Ensure auth is configured.
  4. For destructive actions (
    delete
    ,
    archive
    ,
    revoke
    ), confirm scope with user if ambiguous.
After running commands:
  1. Report the key result in plain language.
  2. Include IDs/URLs returned by Outline when useful.
  3. If command fails, provide likely cause + exact next command to retry.
  4. Do not publish or share documents/collections unless the user asked for it.
执行命令前:
  1. 确认用户意图(读取、写入还是破坏性操作)。
  2. 确认所需的标识符(
    document-id
    collection-id
    等)。
  3. 确保已配置认证信息。
  4. 对于破坏性操作(
    delete
    archive
    revoke
    ),若意图不明确,需与用户确认操作范围。
执行命令后:
  1. 用通俗易懂的语言报告关键结果。
  2. 必要时包含Outline返回的ID/URL。
  3. 若命令执行失败,提供可能的原因 + 用于重试的准确命令。
  4. 除非用户明确要求,否则不要发布或分享文档/集合。

Prerequisites

前置条件

  • Install CLI:
    pip install outline-kb-cli
  • API key format:
    ol_api_...
  • CLI command:
    outline-cli
  • 安装CLI:
    pip install outline-kb-cli
  • API密钥格式:
    ol_api_...
  • CLI命令:
    outline-cli

Configuration

配置

Supported Sources (highest priority first)

支持的配置来源(优先级从高到低)

  1. CLI flags:
    --api-key
    ,
    --base-url
    ,
    --timeout
  2. Environment variables
  3. Project config:
    .outline-skills/config.json
  4. User config:
    ~/.outline-skills/config.json
  1. CLI参数:
    --api-key
    --base-url
    --timeout
  2. 环境变量
  3. 项目配置:
    .outline-skills/config.json
  4. 用户配置:
    ~/.outline-skills/config.json

Important Notes

重要说明

Parameter Order: Global parameters (
--api-key
,
--base-url
,
--timeout
) MUST be placed BEFORE the subcommand:
bash
undefined
参数顺序:全局参数(
--api-key
--base-url
--timeout
)必须放在子命令之前:
bash
undefined

✓ Correct

✓ 正确

outline-cli --api-key "..." --base-url "..." collections list
outline-cli --api-key "..." --base-url "..." collections list

✗ Wrong

✗ 错误

outline-cli collections list --api-key "..." --base-url "..."

**Base URL Format**: The base URL usually include the `/api` suffix:
```bash
outline-cli collections list --api-key "..." --base-url "..."

**Base URL格式**:Base URL通常需要包含`/api`后缀:
```bash

✓ Correct

✓ 正确

✗ Wrong

✗ 错误


**Large Content Input**: Prefer file-backed inputs for longer Markdown/comment bodies instead of very large shell arguments:
```bash
outline-cli documents create --title "Title" --collection-id "collection-id" --text-file ./doc.md
outline-cli documents update --id "document-id" --text-file ./doc.md
outline-cli comments create --document-id "document-id" --data-file ./comment.md
outline-cli comments update --id "comment-id" --data-file ./comment.md

**大内容输入**:对于较长的Markdown/评论内容,优先使用文件作为输入,而非超长的Shell参数:
```bash
outline-cli documents create --title "Title" --collection-id "collection-id" --text-file ./doc.md
outline-cli documents update --id "document-id" --text-file ./doc.md
outline-cli comments create --document-id "document-id" --data-file ./comment.md
outline-cli comments update --id "comment-id" --data-file ./comment.md

Environment Variables

环境变量

bash
export OUTLINE_API_KEY="ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export OUTLINE_BASE_URL="https://app.getoutline.com/api"  # Must include /api suffix
bash
export OUTLINE_API_KEY="ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export OUTLINE_BASE_URL="https://app.getoutline.com/api"  # 必须包含/api后缀

Config File Example

配置文件示例

json
{
  "api_key": "ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "base_url": "https://app.getoutline.com/api",
  "timeout": 30
}
json
{
  "api_key": "ol_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "base_url": "https://app.getoutline.com/api",
  "timeout": 30
}

Quick Command Reference

快速命令参考

Documents

文档操作

bash
outline-cli documents create --title "Title" --text "Content" --collection-id "collection-id"
outline-cli documents create --title "Title" --text-file "./doc.md" --collection-id "collection-id"
outline-cli documents info --id "document-id"
outline-cli documents list --collection-id "collection-id"
outline-cli documents update --id "document-id" --title "New Title"
outline-cli documents update --id "document-id" --text-file "./doc.md"
outline-cli documents archive --id "document-id"
outline-cli documents restore --id "document-id"
outline-cli documents delete --id "document-id"
outline-cli documents move --id "document-id" --collection-id "collection-id"
outline-cli documents duplicate --id "document-id"
outline-cli documents templatize --id "document-id"
outline-cli documents export --id "document-id"
outline-cli documents import --file "./doc.md"   # local file; Markdown/text is imported directly, other files use Outline import flow (supported formats depend on server)
outline-cli documents drafts --collection-id "collection-id"
outline-cli documents archived --limit 25 --offset 0
outline-cli documents deleted --limit 25 --offset 0
outline-cli documents viewed --limit 25 --offset 0
outline-cli documents empty-trash
outline-cli documents unpublish --id "document-id"
outline-cli documents add-user --id "document-id" --user-id "user-id"
outline-cli documents remove-user --id "document-id" --user-id "user-id"
outline-cli documents memberships --id "document-id"
outline-cli documents users --id "document-id"
outline-cli documents add-group --id "document-id" --group-id "group-id"
outline-cli documents remove-group --id "document-id" --group-id "group-id"
outline-cli documents group-memberships --id "document-id"
bash
outline-cli documents create --title "Title" --text "Content" --collection-id "collection-id"
outline-cli documents create --title "Title" --text-file "./doc.md" --collection-id "collection-id"
outline-cli documents info --id "document-id"
outline-cli documents list --collection-id "collection-id"
outline-cli documents update --id "document-id" --title "New Title"
outline-cli documents update --id "document-id" --text-file "./doc.md"
outline-cli documents archive --id "document-id"
outline-cli documents restore --id "document-id"
outline-cli documents delete --id "document-id"
outline-cli documents move --id "document-id" --collection-id "collection-id"
outline-cli documents duplicate --id "document-id"
outline-cli documents templatize --id "document-id"
outline-cli documents export --id "document-id"
outline-cli documents import --file "./doc.md"   # 本地文件;Markdown/文本直接导入,其他文件使用Outline导入流程(支持的格式取决于服务器)
outline-cli documents drafts --collection-id "collection-id"
outline-cli documents archived --limit 25 --offset 0
outline-cli documents deleted --limit 25 --offset 0
outline-cli documents viewed --limit 25 --offset 0
outline-cli documents empty-trash
outline-cli documents unpublish --id "document-id"
outline-cli documents add-user --id "document-id" --user-id "user-id"
outline-cli documents remove-user --id "document-id" --user-id "user-id"
outline-cli documents memberships --id "document-id"
outline-cli documents users --id "document-id"
outline-cli documents add-group --id "document-id" --group-id "group-id"
outline-cli documents remove-group --id "document-id" --group-id "group-id"
outline-cli documents group-memberships --id "document-id"

Collections

集合操作

bash
outline-cli collections list
outline-cli collections info --id "collection-id"
outline-cli collections create --name "Collection Name"
outline-cli collections update --id "collection-id" --name "New Name"
outline-cli collections delete --id "collection-id"
outline-cli collections documents --id "collection-id"
outline-cli collections add-user --id "collection-id" --user-id "user-id"
outline-cli collections remove-user --id "collection-id" --user-id "user-id"
outline-cli collections memberships --id "collection-id"
outline-cli collections add-group --id "collection-id" --group-id "group-id"
outline-cli collections remove-group --id "collection-id" --group-id "group-id"
outline-cli collections group-memberships --id "collection-id"
outline-cli collections export --id "collection-id" --format "markdown"
outline-cli collections export-all --format "markdown"
Sharing workflow for collections:
  • To share a collection with a specific person, use
    collections add-user
    .
  • This requires
    user-id
    , so first find the user with
    users list --query
    , usually by email or name.
  • After creating a collection/document, if sharing may be needed, ask the user whether it should be shared before the next interaction.
  • If sharing with the user you are talking to,
    admin
    is usually the right default.
  • If
    auth info
    shows the API key already belongs to the same person the user wants to share with, no extra sharing is needed.
  • If sharing with someone else, ask whether they should get read-only access or edit/manage access.
  • If the target person is ambiguous, confirm identity before sharing.
bash
outline-cli collections list
outline-cli collections info --id "collection-id"
outline-cli collections create --name "Collection Name"
outline-cli collections update --id "collection-id" --name "New Name"
outline-cli collections delete --id "collection-id"
outline-cli collections documents --id "collection-id"
outline-cli collections add-user --id "collection-id" --user-id "user-id"
outline-cli collections remove-user --id "collection-id" --user-id "user-id"
outline-cli collections memberships --id "collection-id"
outline-cli collections add-group --id "collection-id" --group-id "group-id"
outline-cli collections remove-group --id "collection-id" --group-id "group-id"
outline-cli collections group-memberships --id "collection-id"
outline-cli collections export --id "collection-id" --format "markdown"
outline-cli collections export-all --format "markdown"
集合分享流程:
  • 要与特定用户分享集合,使用
    collections add-user
    命令。
  • 此命令需要
    user-id
    ,因此首先使用
    users list --query
    查找用户,通常通过邮箱或姓名查询。
  • 创建集合/文档后,如果可能需要分享,在下一次交互前询问用户是否需要分享。
  • 如果是与当前对话的用户分享,
    admin
    通常是合适的默认权限。
  • 如果
    auth info
    显示API密钥所属的用户正是要分享的对象,则无需额外分享。
  • 如果是与其他用户分享,询问对方应获得只读权限还是编辑/管理权限。
  • 如果目标用户身份不明确,先确认身份再分享。

Search

搜索操作

bash
outline-cli search "query"
outline-cli search "query" --titles-only
outline-cli search "query" --collection-id "collection-id" --limit 10
bash
outline-cli search "query"
outline-cli search "query" --titles-only
outline-cli search "query" --collection-id "collection-id" --limit 10

Authentication

认证操作

bash
outline-cli auth info  # Get current user and team information
Returns:
  • Current user details (id, name, email, role, preferences)
  • Team/workspace information
  • User's groups and permissions
  • Available teams
Use cases:
  • Verify API key is working and check which user it belongs to
  • Get current user's ID for permission operations
  • Check user's role and permissions
  • Troubleshoot authentication issues
bash
outline-cli auth info  # 获取当前用户和团队信息
返回内容:
  • 当前用户详情(ID、姓名、邮箱、角色、偏好设置)
  • 团队/工作空间信息
  • 用户所属群组及权限
  • 可用团队列表
使用场景:
  • 验证API密钥是否有效,并检查其所属用户
  • 获取当前用户ID用于权限操作
  • 检查用户角色和权限
  • 排查认证问题

Users / Groups

用户/群组操作

bash
outline-cli users list --limit 25
outline-cli users info --id "user-id"
outline-cli users invite --email "new-user@example.com" --name "New User"
outline-cli users update --id "user-id" --name "Updated Name"
outline-cli users update-role --id "user-id" --role member
outline-cli users suspend --id "user-id"
outline-cli users activate --id "user-id"
outline-cli users delete --id "user-id"

outline-cli groups list
outline-cli groups info --id "group-id"
outline-cli groups create --name "Group Name"
outline-cli groups update --id "group-id" --name "New Name"
outline-cli groups delete --id "group-id"
outline-cli groups add-user --id "group-id" --user-id "user-id"
outline-cli groups remove-user --id "group-id" --user-id "user-id"
outline-cli groups memberships --id "group-id"
bash
outline-cli users list --limit 25
outline-cli users info --id "user-id"
outline-cli users invite --email "new-user@example.com" --name "New User"
outline-cli users update --id "user-id" --name "Updated Name"
outline-cli users update-role --id "user-id" --role member
outline-cli users suspend --id "user-id"
outline-cli users activate --id "user-id"
outline-cli users delete --id "user-id"

outline-cli groups list
outline-cli groups info --id "group-id"
outline-cli groups create --name "Group Name"
outline-cli groups update --id "group-id" --name "New Name"
outline-cli groups delete --id "group-id"
outline-cli groups add-user --id "group-id" --user-id "user-id"
outline-cli groups remove-user --id "group-id" --user-id "user-id"
outline-cli groups memberships --id "group-id"

Comments / Attachments

评论/附件操作

Comment Features:
  • outline-cli comments create
    accepts Markdown text through Outline's
    text
    field, so common formatting like paragraphs, lists, bold, italics, and inline code renders as rich text in Outline comments
  • Maximum length is still about 1000 characters per posted comment
  • Longer
    comments create
    replies are auto-split into numbered threaded comments like
    [1/3]
    ,
    [2/3]
    ,
    [3/3]
  • Auto-splitting tries to preserve Markdown block boundaries such as paragraphs, lists, and fenced code blocks
  • Comments can be threaded (replies), resolved/unresolved, and reacted to with emojis
Comment Operations:
bash
outline-cli comments list --document-id "document-id"
outline-cli comments create --document-id "document-id" --data "Comment text"
outline-cli comments create --document-id "document-id" --data-file "./comment.md"
outline-cli comments create --document-id "document-id" --data "Reply text" --parent-id "parent-comment-id"
outline-cli comments update --id "comment-id" --data "Updated comment"
outline-cli comments update --id "comment-id" --data-file "./comment.md"
outline-cli comments delete --id "comment-id"
outline-cli comments resolve --id "comment-id"
outline-cli comments unresolve --id "comment-id"
outline-cli comments add-reaction --id "comment-id" --emoji "👍"
outline-cli comments remove-reaction --id "comment-id" --emoji "👍"
When to use comment features:
  • Use
    resolve
    to mark discussions/issues as completed
  • Use
    unresolve
    to reopen discussions that need more attention
  • Use reactions for quick feedback (👍, ❤️, 😊, etc.)
  • Use
    --parent-id
    to reply to specific comments and create threaded discussions
  • comments create
    is the preferred path for rich-text replies from Markdown input
  • For very long replies, let the CLI auto-split them instead of manually guessing chunk sizes
  • When listing comments on documents with many comments, use
    --limit
    and
    --offset
    for pagination
IMPORTANT - Comment Threading Limitation:
  • Outline only supports ONE level of threading (replies to top-level comments)
  • When replying to a comment that already has a
    parentCommentId
    , you MUST use that comment's parent as your
    --parent-id
    , NOT the comment itself
  • Example:
    • Top-level comment A (parentCommentId: null)
    • Reply B to A (parentCommentId: A's ID)
    • To reply to B, use
      --parent-id A's ID
      , NOT B's ID
  • If you try to reply to a reply (nested 2+ levels), the comment will be created but won't display correctly in the UI
Attachment Operations:
bash
outline-cli attachments create --name "file.pdf" --document-id "document-id" --content-type "application/pdf" --size 1024
outline-cli attachments redirect --id "attachment-id"
outline-cli attachments delete --id "attachment-id"
评论功能:
  • outline-cli comments create
    通过Outline的
    text
    字段接受Markdown文本,因此段落、列表、粗体、斜体和行内代码等常见格式会在Outline评论中渲染为富文本
  • 单条评论的最大长度约为1000字符
  • 较长的
    comments create
    回复会自动拆分为带编号的线程评论,格式如
    [1/3]
    [2/3]
    [3/3]
  • 自动拆分会尽量保留Markdown块边界,如段落、列表和代码块
  • 评论支持线程化(回复)、标记已解决/未解决,以及添加表情反应
评论操作命令:
bash
outline-cli comments list --document-id "document-id"
outline-cli comments create --document-id "document-id" --data "Comment text"
outline-cli comments create --document-id "document-id" --data-file "./comment.md"
outline-cli comments create --document-id "document-id" --data "Reply text" --parent-id "parent-comment-id"
outline-cli comments update --id "comment-id" --data "Updated comment"
outline-cli comments update --id "comment-id" --data-file "./comment.md"
outline-cli comments delete --id "comment-id"
outline-cli comments resolve --id "comment-id"
outline-cli comments unresolve --id "comment-id"
outline-cli comments add-reaction --id "comment-id" --emoji "👍"
outline-cli comments remove-reaction --id "comment-id" --emoji "👍"
何时使用评论功能:
  • 使用
    resolve
    标记讨论/问题已完成
  • 使用
    unresolve
    重新打开需要更多关注的讨论
  • 使用表情反应快速反馈(👍、❤️、😊等)
  • 使用
    --parent-id
    回复特定评论,创建线程化讨论
  • comments create
    是从Markdown输入生成富文本回复的首选方式
  • 对于非常长的回复,让CLI自动拆分,而非手动猜测分块大小
  • 当文档有大量评论时,使用
    --limit
    --offset
    进行分页查询
重要提示 - 评论线程限制:
  • Outline仅支持一级线程化(即仅能回复顶级评论)
  • 当回复已有
    parentCommentId
    的评论时,必须使用该评论的父级ID作为
    --parent-id
    ,而非该评论自身的ID
  • 示例:
    • 顶级评论A(parentCommentId: null)
    • 回复A的评论B(parentCommentId: A的ID)
    • 要回复B,需使用
      --parent-id A的ID
      ,而非B的ID
  • 如果尝试回复回复(嵌套2级及以上),评论会被创建,但在UI中无法正确显示
附件操作命令:
bash
outline-cli attachments create --name "file.pdf" --document-id "document-id" --content-type "application/pdf" --size 1024
outline-cli attachments redirect --id "attachment-id"
outline-cli attachments delete --id "attachment-id"

Shares / Stars / Revisions / Events

分享/星标/修订版本/事件操作

bash
outline-cli shares create --document-id "document-id"
outline-cli shares list --document-id "document-id"
outline-cli shares info --id "share-id"
outline-cli shares revoke --id "share-id"
outline-cli shares update --id "share-id" --published

outline-cli stars create --document-id "document-id"
outline-cli stars list
outline-cli stars delete --id "star-id"
outline-cli stars update --id "star-id" --index 0

outline-cli revisions list --document-id "document-id"
outline-cli revisions info --id "revision-id"

outline-cli events list --limit 25
outline-cli events list --document-id "document-id"
bash
outline-cli shares create --document-id "document-id"
outline-cli shares list --document-id "document-id"
outline-cli shares info --id "share-id"
outline-cli shares revoke --id "share-id"
outline-cli shares update --id "share-id" --published

outline-cli stars create --document-id "document-id"
outline-cli stars list
outline-cli stars delete --id "star-id"
outline-cli stars update --id "star-id" --index 0

outline-cli revisions list --document-id "document-id"
outline-cli revisions info --id "revision-id"

outline-cli events list --limit 25
outline-cli events list --document-id "document-id"

File Operations / Views

文件操作/浏览记录

bash
outline-cli file-operations list --type export
outline-cli file-operations info --id "file-operation-id"
outline-cli file-operations redirect --id "file-operation-id"
outline-cli file-operations delete --id "file-operation-id"

outline-cli views create --document-id "document-id"
outline-cli views list --document-id "document-id" --limit 25
bash
outline-cli file-operations list --type export
outline-cli file-operations info --id "file-operation-id"
outline-cli file-operations redirect --id "file-operation-id"
outline-cli file-operations delete --id "file-operation-id"

outline-cli views create --document-id "document-id"
outline-cli views list --document-id "document-id" --limit 25

Useful Aliases

实用别名

  • outline-cli docs
    /
    outline-cli doc
    ->
    outline-cli documents
  • outline-cli colls
    /
    outline-cli coll
    ->
    outline-cli collections
  • outline-cli docs
    /
    outline-cli doc
    ->
    outline-cli documents
  • outline-cli colls
    /
    outline-cli coll
    ->
    outline-cli collections

Troubleshooting

故障排查

Authentication Errors

认证错误

401 Unauthorized:
  • Check API key exists and starts with
    ol_api_
  • Key may have expired - Ask user to verify the key is still valid in Outline settings
  • Guide user to create a new key: Settings → API → Create new API key
  • Ensure the key hasn't been revoked or deleted
403 Forbidden:
  • Permission scope issue - The API key may not have sufficient permissions
  • Resource access denied - The user account associated with the key may not have access to the requested collection or document
  • Ask user to verify:
    • The API key has the required scopes (read, write, admin)
    • Their account has access to the specific collection/document
    • They are not trying to access archived or deleted resources
401 Unauthorized:
  • 检查API密钥是否存在,且以
    ol_api_
    开头
  • 密钥可能已过期 - 请用户在Outline设置中验证密钥是否仍有效
  • 引导用户创建新密钥:设置 → API → 创建新API密钥
  • 确保密钥未被撤销或删除
403 Forbidden:
  • 权限范围问题 - API密钥可能没有足够的权限
  • 资源访问被拒绝 - 与密钥关联的用户账户可能无权访问请求的集合或文档
  • 请用户验证:
    • API密钥具有所需的权限范围(读取、写入、管理员)
    • 其账户有权访问特定的集合/文档
    • 他们并非尝试访问已归档或已删除的资源

Connection and URL Errors

连接和URL错误

404 Not Found:
  • If specific resource (document/collection): Resource may not exist or has been deleted
  • If basic operations fail (e.g.,
    collections list
    ,
    users list
    ):
    • Base URL is likely incorrect
    • Ask user to confirm the base URL includes
      /api
      suffix
    • Example:
      https://outline.example.com/api
      (not
      https://outline.example.com
      )
    • Verify the Outline instance URL is correct
Connection errors:
  • Verify
    OUTLINE_BASE_URL
    is set correctly
  • Verify instance is reachable (not behind firewall/VPN)
  • Check for typos in the URL
404 Not Found:
  • 如果是特定资源(文档/集合):资源可能不存在或已被删除
  • 如果基础操作失败(例如
    collections list
    users list
    ):
    • Base URL可能不正确
    • 请用户确认Base URL包含
      /api
      后缀
    • 示例:
      https://outline.example.com/api
      (而非
      https://outline.example.com
    • 验证Outline实例的URL是否正确
连接错误:
  • 验证
    OUTLINE_BASE_URL
    是否设置正确
  • 验证实例是否可访问(未被防火墙/VPN阻挡)
  • 检查URL是否有拼写错误

Comment-Specific Issues

评论相关问题

400 Bad Request - "Comment must be less than 1000 characters":
  • Single comment is limited to 1000 characters
  • Solution: Split long content into multiple comments
  • Consider using document content for longer text instead of comments
Comment not rendering Markdown:
  • Comments only support plain text, not Markdown
  • Use document content for formatted text
400 Bad Request - "Comment must be less than 1000 characters":
  • 单条评论限制为1000字符
  • 解决方案:将长内容拆分为多条评论
  • 考虑使用文档内容替代长评论
评论未渲染Markdown:
  • 评论仅支持纯文本,不支持Markdown
  • 如需格式化文本,请使用文档内容

Created content is not visible to the user

创建的内容对用户不可见

  • Ask which Outline account the user is logged in with.
  • The configured API key may belong to a different account than the one the user is using in the web UI.
  • In that case, the created collection/document may need to be shared with the user's account before they can see it.
  • 询问用户登录的是哪个Outline账户。
  • 配置的API密钥可能属于与用户Web UI中使用的不同账户。
  • 这种情况下,创建的集合/文档可能需要分享给用户的账户后,他们才能看到。

Sharing and privacy safety

分享与隐私安全

  • Do not publish or share content unless the user explicitly asked.
  • Prefer email for identity matching when available; users usually will not know their
    user-id
    .
  • If the user asks to share with another person and permission level is unclear, ask before granting access.
  • If you are not sure whether the target account is the user's own account, confirm first.
  • 除非用户明确要求,否则不要发布或分享内容。
  • 优先使用邮箱匹配身份;用户通常不知道自己的
    user-id
  • 如果用户要求与他人分享,但权限级别不明确,先询问再授予访问权限。
  • 如果不确定目标账户是否为用户自己的账户,请先确认。

Command not found

命令未找到

bash
pip install --upgrade outline-kb-cli
bash
pip install --upgrade outline-kb-cli

Safety Notes

安全注意事项

  • Never hardcode API keys
  • Prefer env vars or config files
  • For local config files on Unix:
bash
chmod 600 ~/.outline-skills/config.json
  • Confirm destructive actions before execution when user intent is unclear
  • 切勿硬编码API密钥
  • 优先使用环境变量或配置文件
  • 对于Unix系统上的本地配置文件:
bash
chmod 600 ~/.outline-skills/config.json
  • 当用户意图不明确时,执行破坏性操作前需确认