mirror of
https://github.com/getpaseo/paseo.git
synced 2026-11-21 07:45:38 +00:00
docs(hub): address PR review findings and split dense paragraphs
Fixes all five accuracy findings across English and Simplified Chinese docs: Audience: Everyone default (from_users: ["*"]), queued dispatch retries for offline daemons, launch-time run.github.connection lookup, ${{ paseo.prompt }} in the manual-task API example, and the execution-mode requirement for paseo hub init. Splits all paragraphs and list items longer than three sentences across Hub docs and the Hub sections of CLI and security docs.
This commit is contained in:
+16
-8
@@ -447,21 +447,29 @@ paseo hub deploy -p <project> # Deploy an existing legacy project bundle
|
||||
paseo hub logout # Remove the active stored CLI login
|
||||
```
|
||||
|
||||
Run deploy from the repository root. By default it reads every direct `.paseo/triggers/*.yml` file in deterministic path order. It validates all triggers before installing them one at a time. If an installation fails after earlier ones succeeded, the error lists the installed files. `--dry-run` only validates; it does not create or activate revisions.
|
||||
Run `paseo hub deploy` from the repository root. By default, it reads every direct `.paseo/triggers/*.yml` file in deterministic path order and validates all triggers before installing them one at a time.
|
||||
|
||||
Pass `-p, --project <slug>` for an existing legacy bundle: `.paseo/hub.yml`, direct `.paseo/workflows/*.yml` files, and referenced workflow partials. See [Deploy from the CLI](/docs/hub/configuration#deploy-from-the-cli).
|
||||
If an installation fails after earlier ones succeeded, the error lists the installed files. `--dry-run` validates without creating or activating revisions. Pass `-p, --project <slug>` for an existing legacy project bundle, as described in [Deploy from the CLI](/docs/hub/configuration#deploy-from-the-cli).
|
||||
|
||||
`login` opens the Hub approval page and stores a durable organization-scoped CLI credential under `PASEO_HOME`. In an interactive terminal it offers to connect this daemon, then separately asks whether to allow Hub automations to run agents. Connection defaults to yes; execution permission defaults to no. It then links to Hub's **Triggers** page and prints `paseo hub init` for setup as code. `--json` and non-TTY login remain login-only and never prompt. The stored login is separate from the daemon relationship created by `connect`.
|
||||
`paseo hub login` opens the Hub approval page and stores an organization-scoped CLI credential under `PASEO_HOME`. In an interactive terminal, it offers to connect this daemon (default yes) and separately asks whether to grant `hub.execute` (default no).
|
||||
|
||||
`init` requires a TTY. It signs in and connects the daemon as needed, then lists the organization's app connections that can back a starter trigger. One usable connection is selected automatically; with several, you choose a **Trigger connection**. If none is ready, setup sends you to **Hub → Apps** and stops before selecting an agent or writing files.
|
||||
`--json` and non-TTY logins never prompt. The stored CLI login stays separate from the daemon relationship created by `connect`.
|
||||
|
||||
Setup asks which agent provider, model, and mode to run. Providers must be enabled and expose a selectable model (and an execution mode when the provider offers modes). Suggested model and mode entries are the daemon's defaults; a mode is selected explicitly when there is no default. Hub validates the choice against the daemon before deploying. `deploy` applies the same checks, so it needs the named daemon connected. Setup then asks for the identity allowed to trigger the bot: a GitHub username, Slack member ID, or Discord user ID. It validates the trigger, writes `.paseo/triggers/<provider>-help.yml`, and asks whether to deploy. Replacing that file requires confirmation; existing trigger files are preserved. See the [generated starter trigger](/docs/hub/configuration#generated-starter-trigger).
|
||||
`paseo hub init` requires a TTY, signs in and connects the daemon as needed, and selects a ready integration (or sends you to **Hub → Apps** if none is ready). It then prompts for an enabled provider on your daemon that exposes both a selectable model and at least one execution mode.
|
||||
|
||||
Interactive logout checks the same-origin daemon relationship and asks whether to disconnect before deleting the login. Declining removes only the login. JSON and noninteractive logout never prompt or disconnect implicitly; `--disconnect-daemon` is the explicit automation path, and `--force` applies to that daemon disconnection. If a requested disconnection fails, the login is preserved.
|
||||
Providers that report zero execution modes (such as Pi) are filtered out by `paseo hub init`, but can still be configured in the Hub dashboard or in `.paseo/triggers/*.yml` and deployed with `paseo hub deploy`.
|
||||
|
||||
Every command resolves and normalizes its destination before Hub or daemon work. Origin precedence is an explicit command origin or `--hub`, then `PASEO_HUB_URL`, then the active stored login origin, then the hosted default `https://hub.paseo.sh`. The hosted default never overrides an active login. Credential precedence is `--api-key <secret>`, then `PASEO_HUB_API_KEY`, then a stored login for the exact resolved origin. A stored credential is never sent to a different origin. API keys passed through flags or the environment are not stored.
|
||||
Setup next asks for the allowed sender identity (GitHub username, Slack member ID, or Discord user ID), validates the trigger against the connected daemon, writes `.paseo/triggers/<provider>-help.yml`, and asks whether to deploy. Replacing an existing starter file requires confirmation while preserving other trigger files. See the [generated starter trigger](/docs/hub/configuration#generated-starter-trigger).
|
||||
|
||||
Human output reports the resolved destination before each action. JSON output keeps stdout machine-readable and includes the normalized Hub origin. Bundle diagnostics identify paths without printing configuration contents or credentials.
|
||||
Interactive `paseo hub logout` checks for a daemon connected to the same Hub and asks whether to disconnect it before deleting the login. JSON and non-interactive logouts never prompt or disconnect unless you pass `--disconnect-daemon` (with optional `--force`). If disconnection fails, the login stays intact.
|
||||
|
||||
Every Hub command resolves its destination and credentials in order:
|
||||
|
||||
- Origin precedence: explicit `[url]` or `--hub`, then `PASEO_HUB_URL`, then the active stored login, then `https://hub.paseo.sh`.
|
||||
- Credential precedence: `--api-key <secret>`, then `PASEO_HUB_API_KEY`, then a stored login matching the exact resolved origin.
|
||||
- API keys passed via flags or environment variables are never written to disk, and stored credentials are never sent to another origin.
|
||||
|
||||
Human output prints the resolved destination before each action, while `--json` writes machine-readable output including the normalized Hub origin. Diagnostics name file paths without printing contents or credentials.
|
||||
|
||||
See [Daemons in Hub](/docs/hub/daemons), [Hub configuration](/docs/hub/configuration), and the [Hub public API](/docs/hub/api).
|
||||
|
||||
|
||||
@@ -426,21 +426,29 @@ paseo hub deploy -p <project> # Deploy an existing legacy project bundle
|
||||
paseo hub logout # Remove the active stored CLI login
|
||||
```
|
||||
|
||||
请在仓库根目录运行 deploy。它默认按确定的路径顺序读取所有直接位于 `.paseo/triggers/` 下的 `*.yml` 文件。它会先校验所有触发器,再逐个安装。如果在前面的安装成功之后某个安装失败,错误信息会列出已安装的文件。`--dry-run` 只做校验;它不会创建或激活修订。
|
||||
请在仓库根目录运行 `paseo hub deploy`。它默认按确定的路径顺序读取所有直接位于 `.paseo/triggers/*.yml` 下的文件,并在逐个安装前先校验全部触发器。
|
||||
|
||||
对于已有的旧版文件包,传入 `-p, --project <slug>`:包括 `.paseo/hub.yml`、直接位于 `.paseo/workflows/` 下的 `*.yml` 文件,以及被引用的 workflow 片段。见[从 CLI 部署](/docs/hub/configuration#deploy-from-the-cli)。
|
||||
如果在前面的安装成功之后某个安装失败,错误信息会列出已安装的文件。`--dry-run` 只做校验,不会创建或激活版本。对于已有的旧版项目文件包,请传入 `-p, --project <slug>`,参见[从 CLI 部署](/docs/hub/configuration#deploy-from-the-cli)。
|
||||
|
||||
`login` 会打开 Hub 的批准页面,并在 `PASEO_HOME` 下保存一个持久的、组织范围的 CLI 凭据。在交互式终端中,它会提议连接这个 daemon,然后单独询问是否允许 Hub 自动化在这里运行 Agent。连接默认为是;执行权限默认为否。随后它会链接到 Hub 的 **Triggers** 页面,并输出 `paseo hub init`,以便用代码完成设置。`--json` 和非 TTY 的登录只执行登录,从不提示。保存的登录与 `connect` 创建的 daemon 关系是分开的。
|
||||
`paseo hub login` 会打开 Hub 批准页面,并在 `PASEO_HOME` 下保存组织级 CLI 凭据。在交互式终端中,它会询问是否连接此 daemon(默认为是),并单独询问是否授予 `hub.execute`(默认为否)。
|
||||
|
||||
`init` 需要 TTY。它会根据需要登录并连接 daemon,然后列出组织中可以支撑入门触发器的应用连接。只有一个可用连接时会自动选中;有多个时,由你选择一个 **Trigger connection**。如果没有任何连接就绪,设置会引导你前往 **Hub → Apps**,并在选择 Agent 或写入文件之前停止。
|
||||
`--json` 和非 TTY 登录不会提示。保存的 CLI 登录与 `connect` 创建的 daemon 关系相互独立。
|
||||
|
||||
设置会询问要运行哪个 Agent Provider、模型和模式。Provider 必须已启用,并提供可选择的模型(当 Provider 提供模式时还需要选择执行模式)。建议的模型和模式条目是 daemon 的默认值;没有默认值时仍需显式选择模式。Hub 在部署前会对照 daemon 校验这项选择。`deploy` 会执行相同的检查,因此需要指定的 daemon 已连接。随后设置会询问允许触发机器人的身份:GitHub 用户名、Slack 成员 ID 或 Discord 用户 ID。它会校验触发器,写入 `.paseo/triggers/<provider>-help.yml`,并询问是否部署。替换该文件需要确认;其他触发器文件会被保留。见[生成的入门触发器](/docs/hub/configuration#generated-starter-trigger)。
|
||||
`paseo hub init` 需要 TTY,按需登录并连接 daemon,并选择就绪的集成(若无可用集成则引导至 **Hub → Apps**)。随后它会提示你选择 daemon 上已启用、且同时提供可选模型和至少一个执行模式的 Provider。
|
||||
|
||||
交互式退出会检查同一地址的 daemon 关系,并在删除登录之前询问是否断开。选择否时只删除登录。JSON 和非交互式的退出从不提示,也不会隐式断开;`--disconnect-daemon` 是供自动化使用的显式方式,`--force` 作用于该 daemon 断开操作。如果请求的断开失败,登录会被保留。
|
||||
不提供执行模式的 Provider(例如 Pi)会被 `paseo hub init` 过滤掉,但仍可在 Hub 控制台或 `.paseo/triggers/*.yml` 中配置并通过 `paseo hub deploy` 部署。
|
||||
|
||||
每个命令在执行 Hub 或 daemon 工作之前,都会解析并规范化它的目标。地址的优先级依次为:显式的命令地址或 `--hub`、`PASEO_HUB_URL`、当前保存的登录地址,最后是托管版默认地址 `https://hub.paseo.sh`。托管版默认地址从不会覆盖当前的登录。凭据的优先级依次为:`--api-key <secret>`、`PASEO_HUB_API_KEY`,然后是与解析出的地址完全匹配的已保存登录。保存的凭据从不会发送到其他地址。通过参数或环境变量传入的 API 密钥不会被保存。
|
||||
接着设置会询问允许的发送者身份(GitHub 用户名、Slack 成员 ID 或 Discord 用户 ID),对照已连接的 daemon 校验触发器,写入 `.paseo/triggers/<provider>-help.yml` 并询问是否部署。替换已有入门文件需要确认,同时保留其他触发器文件。见[生成的入门触发器](/docs/hub/configuration#generated-starter-trigger)。
|
||||
|
||||
人类可读的输出会在每个操作之前报告解析出的目标。JSON 输出让 stdout 保持机器可读,并包含规范化后的 Hub 地址。文件包诊断会指出路径,但不会输出配置内容或凭据。
|
||||
交互式 `paseo hub logout` 会检查连接到同一 Hub 的 daemon,并在删除登录前询问是否断开。JSON 和非交互式退出不会提示或断开,除非传入 `--disconnect-daemon`(可配合 `--force`)。如果断开失败,登录凭据会保留。
|
||||
|
||||
每个 Hub 命令都按顺序解析目标和凭据:
|
||||
|
||||
- 地址优先级:显式 `[url]` 或 `--hub`、`PASEO_HUB_URL`、当前已保存的登录,最后是 `https://hub.paseo.sh`。
|
||||
- 凭据优先级:`--api-key <secret>`、`PASEO_HUB_API_KEY`,然后是与精确解析地址匹配的已保存登录。
|
||||
- 通过参数或环境变量传入的 API 密钥永远不会写入磁盘,已保存的凭据也不会发送到其他地址。
|
||||
|
||||
人类可读输出会在每个操作前打印解析出的目标,而 `--json` 会输出包含规范化 Hub 地址的机器可读结果。诊断信息仅指出文件路径,不输出文件内容或凭据。
|
||||
|
||||
见 [Hub 中的 daemon](/docs/hub/daemons)、[Hub 配置](/docs/hub/configuration)和 [Hub 公开 API](/docs/hub/api)。
|
||||
|
||||
|
||||
@@ -29,8 +29,8 @@ Check these items in order:
|
||||
|
||||
1. Open **Activity**. If the event is missing there, check **Integrations → Known unrouted events** and read the recorded reason.
|
||||
2. If the event does not appear in either view, the provider never reached Hub. Check the provider delivery log (GitHub **App → Advanced → Recent Deliveries**, Linear webhook logs, or Slack **Event Subscriptions**) and make sure that the app subscribes to that event type.
|
||||
3. Verify `from_users`. GitHub uses login names. Linear, Slack, and Discord use user IDs rather than display names. See [Linear triggers](/docs/hub/triggers/linear#filters-and-linear-uuids), [Slack triggers](/docs/hub/triggers/slack#find-your-slack-ids), and [Discord triggers](/docs/hub/triggers/discord#find-your-discord-ids).
|
||||
4. Verify text filters. On GitHub and Linear comments, `contains` matches a substring and `pattern` matches the start. On Slack and Discord, the message must mention the bot and any `pattern` must immediately follow the mention. On GitHub, make sure that `exclude_contains` did not exclude the comment.
|
||||
3. Verify `from_users`. GitHub uses login names, while Linear, Slack, and Discord use user IDs ([Linear](/docs/hub/triggers/linear#filters-and-linear-uuids), [Slack](/docs/hub/triggers/slack#find-your-slack-ids), [Discord](/docs/hub/triggers/discord#find-your-discord-ids)).
|
||||
4. Verify text filters (`contains`, `pattern`, and GitHub `exclude_contains`). On Slack and Discord, the message must mention the bot and any `pattern` must follow the mention.
|
||||
5. Verify that the trigger is enabled under **Triggers**.
|
||||
6. Verify that the target daemon is connected under **Daemons** and holds the `hub.execute` permission.
|
||||
7. If the run started and stopped early, compare its duration against `max_runtime`, `idle_timeout`, and `startup_timeout`.
|
||||
|
||||
@@ -27,8 +27,8 @@ Hub 会记录每一次已接受的事件,无论它是否启动了运行。使
|
||||
|
||||
1. 打开 **Activity**。如果事件未出现在那里,请检查 **Integrations → Known unrouted events** 并查看记录的原因。
|
||||
2. 如果两处都没有,说明事件从未到达 Hub。检查 Provider 自己的投递日志(GitHub **App → Advanced → Recent Deliveries**、Linear webhook 日志或 Slack **Event Subscriptions**),并确认应用已订阅对应事件类型。
|
||||
3. 检查 `from_users`。GitHub 使用登录名,Linear、Slack 和 Discord 使用用户 ID 而不是显示名称。参见 [Linear 触发器](/docs/hub/triggers/linear#filters-and-linear-uuids)、[Slack 触发器](/docs/hub/triggers/slack#find-your-slack-ids)和 [Discord 触发器](/docs/hub/triggers/discord#find-your-discord-ids)。
|
||||
4. 检查文本过滤条件。在 GitHub 和 Linear 评论上,`contains` 匹配子串,`pattern` 匹配开头。在 Slack 和 Discord 上,消息必须提及机器人,且任何 `pattern` 都必须紧跟在提及之后。在 GitHub 上,还要确认 `exclude_contains` 没有将该评论排除。
|
||||
3. 检查 `from_users`。GitHub 使用登录名,Linear、Slack 和 Discord 使用用户 ID(参见 [Linear](/docs/hub/triggers/linear#filters-and-linear-uuids)、[Slack](/docs/hub/triggers/slack#find-your-slack-ids)、[Discord](/docs/hub/triggers/discord#find-your-discord-ids))。
|
||||
4. 检查文本过滤条件(`contains`、`pattern` 以及 GitHub 的 `exclude_contains`)。在 Slack 和 Discord 上,消息必须提及机器人,且任何 `pattern` 都必须紧跟在提及之后。
|
||||
5. 在 **Triggers** 下确认触发器已启用。
|
||||
6. 在 **Daemons** 下确认目标 daemon 已连接并拥有 `hub.execute` 权限。
|
||||
7. 如果运行已启动但提前停止,请将其持续时间与 `max_runtime`、`idle_timeout` 和 `startup_timeout` 进行对比。
|
||||
|
||||
@@ -65,7 +65,7 @@ A valid credential missing the required scope returns `403` in the same format.
|
||||
|
||||
```json
|
||||
{
|
||||
"yaml": "name: manual-task\nenabled: true\non:\n manual.run: {}\nrun:\n target: { daemon: my-macbook, cwd: /workspace }\n agent: { provider: codex, mode: full-access }\n prompt: Complete the task and call finish_execution.\n max_runtime: 1h\n idle_timeout: 5m\n"
|
||||
"yaml": "name: manual-task\nenabled: true\non:\n manual.run: {}\nrun:\n target: { daemon: my-macbook, cwd: /workspace }\n agent: { provider: codex, mode: full-access }\n prompt: |\n Complete the task and call finish_execution.\n ${{ paseo.prompt }}\n max_runtime: 1h\n idle_timeout: 5m\n"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ API 错误返回 RFC 9457 `application/problem+json` 格式并带有 `X-Request-
|
||||
|
||||
```json
|
||||
{
|
||||
"yaml": "name: manual-task\nenabled: true\non:\n manual.run: {}\nrun:\n target: { daemon: my-macbook, cwd: /workspace }\n agent: { provider: codex, mode: full-access }\n prompt: Complete the task and call finish_execution.\n max_runtime: 1h\n idle_timeout: 5m\n"
|
||||
"yaml": "name: manual-task\nenabled: true\non:\n manual.run: {}\nrun:\n target: { daemon: my-macbook, cwd: /workspace }\n agent: { provider: codex, mode: full-access }\n prompt: |\n Complete the task and call finish_execution.\n ${{ paseo.prompt }}\n max_runtime: 1h\n idle_timeout: 5m\n"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ GitHub / Linear / Slack / Discord / Schedule / Webhook
|
||||
|
||||
## From event to agent
|
||||
|
||||
1. An event arrives. GitHub, Linear, Slack (Webhooks transport), and inbound webhooks send signed or authenticated HTTPS requests to Hub. Slack Socket Mode and Discord connect out from Hub. Schedules fire on Hub's own clock.
|
||||
1. An event arrives via HTTPS webhooks (GitHub, Linear, Slack Webhooks, or inbound webhooks), an outbound connection (Slack Socket Mode or Discord gateway), or Hub's schedule clock.
|
||||
2. Hub verifies the sender or signature and looks up matching enabled triggers.
|
||||
3. For external provider events, Hub evaluates the trigger's connection, resource filters, and sender allowlist (`from_users`).
|
||||
4. For each matching trigger, Hub creates a run and sends the launch intent to the target daemon over the same RPC protocol used by the Paseo app and CLI.
|
||||
|
||||
@@ -30,7 +30,7 @@ GitHub / Linear / Slack / Discord / Schedule / Webhook
|
||||
|
||||
## 从事件到 Agent {#from-event-to-agent}
|
||||
|
||||
1. 事件到达。GitHub、Linear、Slack(Webhooks 传输方式)和入站 webhook 向 Hub 发送带签名或已认证的 HTTPS 请求。Slack Socket Mode 和 Discord 由 Hub 主动向外连接。定时任务按 Hub 自身的时钟触发。
|
||||
1. 事件通过 HTTPS webhook(GitHub、Linear、Slack Webhooks 或入站 webhook)、出站连接(Slack Socket Mode 或 Discord gateway)或 Hub 定时时钟到达。
|
||||
2. Hub 验证发送者或签名,并查找匹配的已启用触发器。
|
||||
3. 对于外部 Provider 事件,Hub 会评估触发器的连接、资源过滤条件和发送者白名单(`from_users`)。
|
||||
4. 对每个匹配的触发器,Hub 创建一次运行,并通过 Paseo 应用和 CLI 使用的同一套 RPC 协议向目标 daemon 发送启动意图。
|
||||
|
||||
@@ -99,7 +99,9 @@ paseo hub deploy
|
||||
|
||||
Both commands read every direct `.paseo/triggers/*.yml` file in deterministic path order. The CLI rejects nested directories, `.yaml` extensions, symlinks, and unreadable files, and does not search parent directories.
|
||||
|
||||
`--dry-run` validates every file against Hub and your connected daemons without writing revisions. `paseo hub deploy` validates all files first, then installs each trigger by its YAML `name`. If a later trigger fails to install, the error lists the files already installed. Redeploying an existing webhook trigger name preserves its webhook URL and secret.
|
||||
`--dry-run` validates every file against Hub and your connected daemons without writing revisions. `paseo hub deploy` validates all files first, then installs each trigger by its YAML `name`.
|
||||
|
||||
If a later trigger fails to install, the error lists the files already installed. Redeploying an existing webhook trigger name preserves its webhook URL and secret.
|
||||
|
||||
Origin precedence:
|
||||
|
||||
|
||||
@@ -97,7 +97,9 @@ paseo hub deploy
|
||||
|
||||
两个命令都会按确定的路径顺序读取直接位于 `.paseo/triggers/*.yml` 下的文件。CLI 会拒绝嵌套目录、`.yaml` 扩展名、符号链接和不可读文件,并且不会向上搜索父目录。
|
||||
|
||||
`--dry-run` 会对照 Hub 和已连接的 daemon 校验所有文件,但不写入版本。`paseo hub deploy` 会先校验全部文件,再按 YAML 中的 `name` 逐个安装。如果后面的触发器安装失败,错误信息会列出已成功安装的文件。重新部署同名的 webhook 触发器会保留它的 webhook URL 和密钥。
|
||||
`--dry-run` 会对照 Hub 和已连接的 daemon 校验所有文件,但不写入版本。`paseo hub deploy` 会先校验全部文件,再按 YAML 中的 `name` 逐个安装。
|
||||
|
||||
如果后面的触发器安装失败,错误信息会列出已成功安装的文件。重新部署同名的 webhook 触发器会保留它的 webhook URL 和密钥。
|
||||
|
||||
地址优先级:
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ paseo hub login https://hub.example.com
|
||||
|
||||
The CLI prints a URL and verification code and opens your browser. After approval, Paseo stores an organization-scoped CLI login under `PASEO_HOME`.
|
||||
|
||||
In an interactive terminal, `login` offers to connect this daemon and separately asks whether to allow Hub automations to run agents. Connection defaults to yes. Execution permission defaults to no. `--json` and non-TTY logins do not prompt.
|
||||
In an interactive terminal, `login` offers to connect this daemon and separately asks whether to allow Hub automations to run agents. Connection defaults to yes, and execution permission defaults to no. `--json` and non-TTY logins do not prompt.
|
||||
|
||||
If you skipped connection during login, enroll the daemon separately:
|
||||
|
||||
@@ -30,7 +30,9 @@ paseo hub connect
|
||||
|
||||
`connect` uses your active login to request a single-use enrollment token. The daemon exchanges that token for its own relationship credential, so your CLI login is never stored as daemon authority.
|
||||
|
||||
Hub derives the daemon's initial slug from its hostname. If that slug is already taken in the organization, Hub appends a short daemon ID suffix. Slugs use lowercase words joined by hyphens, so `Build Studio` becomes `build-studio`. You can rename the slug later in Hub without changing the immutable daemon ID, then update any triggers that reference the old slug.
|
||||
Hub derives the daemon's initial slug from its hostname using lowercase words joined by hyphens, such as `build-studio`. If that slug is already taken in the organization, Hub appends a short daemon ID suffix.
|
||||
|
||||
You can rename the slug later in Hub without changing the immutable daemon ID, then update any triggers that reference the old slug.
|
||||
|
||||
For unattended setup, pass an organization API key through the environment:
|
||||
|
||||
|
||||
@@ -28,7 +28,9 @@ paseo hub connect
|
||||
|
||||
`connect` 使用当前登录凭据申请一个一次性注册令牌。daemon 用该令牌换取自己的关系凭据,因此你的 CLI 登录凭据永远不会作为 daemon 权限保存。
|
||||
|
||||
Hub 根据主机名生成 daemon 的初始 slug。如果组织内已有同名 slug,Hub 会附加一个短 daemon ID 后缀。slug 使用连字符连接的小写单词,例如 `Build Studio` 会变成 `build-studio`。之后可以在 Hub 中重命名 slug,不会改变不可变的 daemon ID,但需要更新引用旧 slug 的触发器。
|
||||
Hub 根据主机名生成使用连字符连接的小写初始 slug,例如 `build-studio`。如果组织内已有同名 slug,Hub 会附加一个短 daemon ID 后缀。
|
||||
|
||||
之后可以在 Hub 中重命名 slug,不会改变不可变的 daemon ID,但需要更新引用旧 slug 的触发器。
|
||||
|
||||
无人值守环境中,可通过环境变量传入组织 API 密钥:
|
||||
|
||||
|
||||
+12
-4
@@ -26,11 +26,15 @@ Yes. Integrations belong to the organization under **Integrations**, and each co
|
||||
|
||||
## Who can trigger an agent?
|
||||
|
||||
For GitHub, Slack, Discord, and Linear comment or assignment triggers, only users listed in `from_users` can trigger a run. `linear.issue_entered_scope` requires `filters.project` and can omit `from_users`. Inbound webhooks authenticate callers with a Bearer secret (`whsec_...`), and schedules fire on Hub's own clock.
|
||||
For GitHub, Slack, Discord, and Linear comment or assignment triggers, Hub checks the sender against `from_users`. Setting `from_users: ["*"]` (the dashboard's **Audience: Everyone** default) allows any sender, while listing named logins or user IDs restricts access.
|
||||
|
||||
`linear.issue_entered_scope` requires `filters.project` and can omit `from_users`. Inbound webhooks authenticate callers with a Bearer secret (`whsec_...`), and schedules fire on Hub's own clock.
|
||||
|
||||
## Can an agent reply back to GitHub, Linear, Slack, or Discord?
|
||||
|
||||
Yes. Conversational triggers (`github.*`, `linear.*`, `slack.*`, `discord.*`) automatically grant the Hub MCP `reply` tool, which posts back to the triggering issue, pull request, or thread. Add `run.outputs` to set `max` or `required: true`, and tell the agent to call `reply` and `finish_execution` in `run.prompt`. When Hub runs over HTTPS, replies include an **Open in Paseo** link for signed-in organization members.
|
||||
Yes. Conversational triggers (`github.*`, `linear.*`, `slack.*`, `discord.*`) automatically grant the Hub MCP `reply` tool, which posts back to the triggering issue, pull request, or thread.
|
||||
|
||||
Add `run.outputs` to set `max` or `required: true`, and tell the agent to call `reply` and `finish_execution` in `run.prompt`. When Hub runs over HTTPS, replies include an **Open in Paseo** link for signed-in organization members.
|
||||
|
||||
## Can a schedule or webhook post to Slack or Discord?
|
||||
|
||||
@@ -38,11 +42,15 @@ Yes. Add [`run.tools`](/docs/hub/tools) (or configure **Integration tools** in t
|
||||
|
||||
## What happens when a daemon is offline?
|
||||
|
||||
Dispatch fails and Hub records the failure in **Activity**. For provider events and webhooks, Hub does not silently replay failed dispatches later, so trigger the event again once the daemon reconnects. Scheduled triggers continue firing at future occurrences and skip overlapping ticks while a run is active.
|
||||
When Hub accepts a provider event or inbound webhook while the target daemon is offline, Hub keeps the run queued and retries dispatch until its `max_runtime` deadline expires. If the daemon reconnects in time, the queued run starts automatically, so resending the event can start a duplicate run.
|
||||
|
||||
Wait for **Activity** to show a terminal failure before sending a new event. Scheduled triggers continue firing at future occurrences and skip overlapping ticks while an earlier run is active.
|
||||
|
||||
## Does logging out disconnect my daemon?
|
||||
|
||||
No. The CLI login is a human credential stored under `PASEO_HOME`, while an enrolled daemon holds its own relationship credential. Interactive `paseo hub logout` offers to disconnect a daemon connected to the same Hub before deleting the login. Non-interactive and `--json` logout never disconnect the daemon unless you pass `--disconnect-daemon`.
|
||||
No. The CLI login is a human credential stored under `PASEO_HOME`, while an enrolled daemon holds its own relationship credential.
|
||||
|
||||
Interactive `paseo hub logout` offers to disconnect a daemon connected to the same Hub before deleting the login. Non-interactive and `--json` logout never disconnect the daemon unless you pass `--disconnect-daemon`.
|
||||
|
||||
## Can I use Hub without GitHub?
|
||||
|
||||
|
||||
@@ -24,11 +24,15 @@ Hub 可以运行你已连接的 Paseo daemon 上配置的任意 Provider,包
|
||||
|
||||
## 谁可以触发 Agent? {#who-can-trigger-an-agent}
|
||||
|
||||
对于 GitHub、Slack、Discord 以及 Linear 评论和分配触发器,只有列在 `from_users` 中的用户可以触发运行。`linear.issue_entered_scope` 要求设置 `filters.project` 且可以省略 `from_users`。入站 webhook 通过 Bearer 密钥(`whsec_...`)验证调用方,定时任务则按 Hub 自己的时钟触发。
|
||||
对于 GitHub、Slack、Discord 以及 Linear 评论和分配触发器,Hub 会对照 `from_users` 检查发送者。设置为 `from_users: ["*"]`(控制台 **Audience: Everyone** 的默认值)时允许任意发送者,列出具名登录名或用户 ID 时则只允许这些账号。
|
||||
|
||||
`linear.issue_entered_scope` 要求设置 `filters.project` 且可以省略 `from_users`。入站 webhook 通过 Bearer 密钥(`whsec_...`)验证调用方,定时任务则按 Hub 自己的时钟触发。
|
||||
|
||||
## Agent 可以回复到 GitHub、Linear、Slack 或 Discord 吗? {#can-an-agent-reply-back-to-github-linear-slack-or-discord}
|
||||
|
||||
可以。对话类触发器(`github.*`、`linear.*`、`slack.*`、`discord.*`)会自动授予 Hub MCP `reply` 工具,将回复发布回触发运行的 issue、Pull Request 或讨论串。添加 `run.outputs` 可设置 `max` 或 `required: true`,并在 `run.prompt` 中指示 Agent 调用 `reply` 和 `finish_execution`。当 Hub 运行在 HTTPS 下时,回复会为已登录的组织成员附带 **Open in Paseo** 链接。
|
||||
可以。对话类触发器(`github.*`、`linear.*`、`slack.*`、`discord.*`)会自动授予 Hub MCP `reply` 工具,将回复发布回触发运行的 issue、Pull Request 或讨论串。
|
||||
|
||||
添加 `run.outputs` 可设置 `max` 或 `required: true`,并在 `run.prompt` 中指示 Agent 调用 `reply` 和 `finish_execution`。当 Hub 运行在 HTTPS 下时,回复会为已登录的组织成员附带 **Open in Paseo** 链接。
|
||||
|
||||
## 定时任务或 webhook 可以发送到 Slack 或 Discord 吗? {#can-a-schedule-or-webhook-post-to-slack-or-discord}
|
||||
|
||||
@@ -36,11 +40,15 @@ Hub 可以运行你已连接的 Paseo daemon 上配置的任意 Provider,包
|
||||
|
||||
## daemon 离线时会发生什么? {#what-happens-when-a-daemon-is-offline}
|
||||
|
||||
派发会失败,Hub 会在 **Activity** 中记录失败。对于 Provider 事件和 webhook,Hub 不会在之后静默重放失败的派发,daemon 重新上线后需要再次触发。定时触发器会在未来计划时间继续触发,并在已有运行活跃时跳过重叠的计划。
|
||||
如果目标 daemon 离线时 Hub 接受了 Provider 事件或入站 webhook,Hub 会将该运行保留在队列中并重试派发,直到达到 `max_runtime` 截止时间。如果 daemon 在截止时间前重新上线,排队中的运行会自动启动,因此重新发送事件可能会造成重复运行。
|
||||
|
||||
请等到 **Activity** 显示该运行已进入终态失败后再发送新事件。定时触发器会在未来计划时间继续触发,并在前一次运行活跃时跳过重叠的计划。
|
||||
|
||||
## 退出登录会断开我的 daemon 吗? {#does-logging-out-disconnect-my-daemon}
|
||||
|
||||
不会。CLI 登录是保存在 `PASEO_HOME` 下的个人凭据,而已注册的 daemon 持有自己的关系凭据。交互式 `paseo hub logout` 会在删除登录前询问是否断开连接到同一 Hub 的 daemon。非交互式和 `--json` 退出登录除非传入 `--disconnect-daemon`,否则不会断开 daemon。
|
||||
不会。CLI 登录是保存在 `PASEO_HOME` 下的个人凭据,而已注册的 daemon 持有自己的关系凭据。
|
||||
|
||||
交互式 `paseo hub logout` 会在删除登录前询问是否断开连接到同一 Hub 的 daemon。非交互式和 `--json` 退出登录除非传入 `--disconnect-daemon`,否则不会断开 daemon。
|
||||
|
||||
## 不使用 GitHub 也能用 Hub 吗? {#can-i-use-hub-without-github}
|
||||
|
||||
|
||||
@@ -58,7 +58,9 @@ run:
|
||||
| `permissions` | Installation-token permissions such as `contents`, `pull_requests`, and `issues` (`read`, `write`, or `admin`). Defaults to `contents: read`. |
|
||||
| `duration` | Positive token lifetime up to `1h`. Defaults to `1h`, GitHub's maximum. |
|
||||
|
||||
Requested permissions cannot exceed what the GitHub App installation allows. Saving or deploying fails if the connection, repository, or permission cannot be resolved.
|
||||
Requested permissions cannot exceed what the GitHub App installation allows.
|
||||
|
||||
When you save or deploy a trigger, Hub validates the `run.github` schema, any GitHub event filters (`on.github.*`), and the agent configuration. Hub looks up `run.github.connection` and mints the installation token when the run launches, so a nonexistent slug, unreachable repository, or excess permission fails at launch rather than at deploy time.
|
||||
|
||||
## Agent environment
|
||||
|
||||
|
||||
@@ -56,7 +56,9 @@ run:
|
||||
| `permissions` | 安装令牌权限,例如 `contents`、`pull_requests` 和 `issues`(`read`、`write` 或 `admin`)。默认为 `contents: read`。 |
|
||||
| `duration` | 正的令牌有效期,最长 `1h`。默认为 `1h`(GitHub 上限)。 |
|
||||
|
||||
请求的权限不能超过 GitHub App 安装本身被授予的权限。如果连接、仓库或权限无法解析,保存或部署会直接失败。
|
||||
请求的权限不能超过 GitHub App 安装本身被授予的权限。
|
||||
|
||||
保存或部署触发器时,Hub 会校验 `run.github` 字段结构、GitHub 事件过滤条件(`on.github.*`)以及 Agent 配置。Hub 会在运行启动时才查找 `run.github.connection` 并签发安装令牌,因此不存在的 slug、无法访问的仓库或超出范围的权限会在启动时失败,而不是在部署时失败。
|
||||
|
||||
## Agent 环境 {#agent-environment}
|
||||
|
||||
|
||||
@@ -64,11 +64,13 @@ paseo hub init
|
||||
|
||||
Choose your local Hub endpoint (`http://localhost:3000`) and select your Slack connection if prompted. Setup asks three questions:
|
||||
|
||||
| Prompt | Value to provide |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| Starter agent provider, model, and mode | Any enabled provider on your daemon. Suggested model and mode entries are its defaults. |
|
||||
| Your Slack member ID | Your Slack ID, such as `U01234567`. Only listed users can trigger the bot. |
|
||||
| Deploy now? | Yes, to validate and install the trigger in Hub. |
|
||||
| Prompt | Value to provide |
|
||||
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Starter agent provider, model, and mode | An enabled provider on your daemon with a selectable model and at least one execution mode (such as Claude, Codex, or OpenCode). |
|
||||
| Your Slack member ID | Your Slack ID, such as `U01234567`. Only listed users can trigger the bot. |
|
||||
| Deploy now? | Yes, to validate and install the trigger in Hub. |
|
||||
|
||||
Providers that advertise zero execution modes (such as Pi) are skipped by `paseo hub init`, but you can configure them in the Hub dashboard or in `.paseo/triggers/*.yml` and deploy with `paseo hub deploy`.
|
||||
|
||||
See [Find your Slack IDs](/docs/hub/triggers/slack#find-your-slack-ids) to copy your member ID.
|
||||
|
||||
|
||||
@@ -62,11 +62,13 @@ paseo hub init
|
||||
|
||||
选择本地 Hub 地址(`http://localhost:3000`),如果出现提示则选择你的 Slack 连接。设置过程会询问三个问题:
|
||||
|
||||
| 提示 | 需要提供的值 |
|
||||
| ------------------------------- | -------------------------------------------------------------------------- |
|
||||
| 入门 Agent Provider、模型和模式 | daemon 上任意已启用的 Provider。建议的模型和模式条目是该 daemon 的默认值。 |
|
||||
| 你的 Slack 成员 ID | 你的 Slack ID,例如 `U01234567`。只有列出的用户才能触发机器人。 |
|
||||
| 是否立即部署? | 选择是,在 Hub 中校验并安装该触发器。 |
|
||||
| 提示 | 需要提供的值 |
|
||||
| ------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| 入门 Agent Provider、模型和模式 | daemon 上已启用、且同时提供可选模型和至少一个执行模式的 Provider(例如 Claude、Codex、OpenCode)。 |
|
||||
| 你的 Slack 成员 ID | 你的 Slack ID,例如 `U01234567`。只有列出的用户才能触发机器人。 |
|
||||
| 是否立即部署? | 选择是,在 Hub 中校验并安装该触发器。 |
|
||||
|
||||
不提供执行模式的 Provider(例如 Pi)会被 `paseo hub init` 跳过,但仍可在 Hub 控制台或 `.paseo/triggers/*.yml` 中配置并通过 `paseo hub deploy` 部署。
|
||||
|
||||
查看[查找 Slack ID](/docs/hub/triggers/slack#find-your-slack-ids)了解如何复制成员 ID。
|
||||
|
||||
|
||||
@@ -61,7 +61,9 @@ DATABASE_URL=postgres://paseo:password@localhost:5432/paseo_hub \
|
||||
|
||||
Use PostgreSQL for a durable server deployment, multiple Hub processes, or standard database backups. Migrations run automatically at startup, and Hub refuses to listen if a migration fails.
|
||||
|
||||
The database also stores Hub's generated authentication secret. Set `PASEO_HUB_AUTH_SECRET` only when your platform injects that secret from an external secret store. While set, Hub uses the override without replacing the stored secret. Changing the active secret signs dashboard users out, while running executions keep their existing credentials until they end.
|
||||
The database also stores Hub's generated authentication secret. Set `PASEO_HUB_AUTH_SECRET` only when your platform injects that secret from an external secret store.
|
||||
|
||||
While set, Hub uses the override without replacing the stored secret. Changing the active secret signs dashboard users out, while running executions keep their existing credentials until they end.
|
||||
|
||||
## App configuration
|
||||
|
||||
|
||||
@@ -59,7 +59,9 @@ DATABASE_URL=postgres://paseo:password@localhost:5432/paseo_hub \
|
||||
|
||||
对于持久的服务器部署、多个 Hub 进程或标准数据库备份,请使用 PostgreSQL。数据库迁移会在启动时自动运行,迁移失败时 Hub 不会开始监听。
|
||||
|
||||
数据库同时保存 Hub 生成的认证密钥。仅当平台必须从外部密钥存储注入该密钥时,才设置 `PASEO_HUB_AUTH_SECRET`。设置该覆盖项期间,Hub 会使用它而不替换已存储的密钥。修改生效密钥会让控制台用户退出登录,正在进行的执行会保留原有凭据直到结束。
|
||||
数据库同时保存 Hub 生成的认证密钥。仅当平台必须从外部密钥存储注入该密钥时,才设置 `PASEO_HUB_AUTH_SECRET`。
|
||||
|
||||
设置该覆盖项期间,Hub 会使用它而不替换已存储的密钥。修改生效密钥会让控制台用户退出登录,正在进行的执行会保留原有凭据直到结束。
|
||||
|
||||
## 应用配置 {#app-configuration}
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ run:
|
||||
|
||||
Discord filters use numeric snowflake IDs, not server names, display names, or connection slugs. Quote every snowflake ID so YAML keeps it as a string.
|
||||
|
||||
`from_users` is required and matches the sender. `guild` and `channels` restrict where the mention arrived. `pattern` requires a prefix after the mention (`contains` is its legacy alias with the same prefix behavior). All filters compose with AND.
|
||||
`from_users` is required and matches the sender, while `guild` and `channels` restrict where the mention arrived. `pattern` requires a prefix after the mention (`contains` is its legacy alias with the same prefix behavior). All filters compose with AND.
|
||||
|
||||
`${{ paseo.prompt }}` contains the complete received message text. If you declare `inputs`, Hub parses leading `key=value` tokens after the mention into `${{ paseo.inputs }}`. Include `${{ paseo.context }}` in `run.prompt` to pass the referenced message, thread history, and attachment descriptors as JSON.
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ run:
|
||||
|
||||
Discord 过滤条件使用数字 snowflake ID,而不是服务器名称、显示名称或连接 slug。请为每个 snowflake ID 加上引号,让 YAML 将其保留为字符串。
|
||||
|
||||
`from_users` 为必填项,匹配发送者。`guild` 和 `channels` 限制提及出现的位置。`pattern` 要求提及之后紧跟指定前缀(`contains` 是其旧别名,前缀行为相同)。所有过滤条件按逻辑与组合。
|
||||
`from_users` 为必填项,匹配发送者,`guild` 和 `channels` 限制提及出现的位置。`pattern` 要求提及之后紧跟指定前缀(`contains` 是其旧别名,前缀行为相同)。所有过滤条件按逻辑与组合。
|
||||
|
||||
`${{ paseo.prompt }}` 包含收到的完整消息文本。如果你声明了 `inputs`,Hub 会将提及之后紧跟的 `key=value` 头部解析到 `${{ paseo.inputs }}`。在 `run.prompt` 中包含 `${{ paseo.context }}`,即可以 JSON 形式传入被引用的消息、讨论串历史和附件描述符。
|
||||
|
||||
|
||||
@@ -129,7 +129,9 @@ External provider triggers require a non-empty `from_users` allowlist. There are
|
||||
- `schedule.tick` uses `recurrence` and accepts no `connection` or `filters`.
|
||||
- `webhook.received` authenticates callers with a Bearer secret and accepts no `connection` or `filters`.
|
||||
|
||||
The `from_users` allowlist stops a stranger's comment on a public issue from starting an agent on your machine. Allowlists do not sandbox the agent or sanitize untrusted text, so read [Hub security](/docs/hub/security) before widening them.
|
||||
The dashboard trigger form defaults **Audience** to **Everyone**, which saves `from_users: ["*"]` and lets any user on a public repository or workspace start a run. To restrict access, choose **Specific people** in the form or list explicit logins or user IDs in `from_users`.
|
||||
|
||||
Allowlists do not sandbox the agent or sanitize untrusted text, so read [Hub security](/docs/hub/security) before granting write access or widening the audience.
|
||||
|
||||
| Filter | Applies to | Matches |
|
||||
| ------------------ | ------------------------------ | ---------------------------------------------------------------------------------- |
|
||||
|
||||
@@ -127,7 +127,9 @@ Hub 会在每段提示词中附带 `executionId`。在持续运行的 Agent 上
|
||||
- `schedule.tick` 使用 `recurrence`,不接受 `connection` 或 `filters`。
|
||||
- `webhook.received` 通过 Bearer 密钥验证调用方,不接受 `connection` 或 `filters`。
|
||||
|
||||
`from_users` 白名单可以防止陌生人在公开 issue 上发表评论就启动你机器上的 Agent。白名单不能为 Agent 提供沙箱隔离,也不会清洗不可信文本,扩大范围前请先阅读 [Hub 安全](/docs/hub/security)。
|
||||
控制台触发器表单默认将 **Audience** 设为 **Everyone**,保存为 `from_users: ["*"]`,允许公开仓库或工作区中的任意用户启动运行。如需限制访问,请在表单中选择 **Specific people**,或在 YAML 的 `from_users` 中显式列出登录名或用户 ID。
|
||||
|
||||
白名单不能为 Agent 提供沙箱隔离,也不会清洗不可信文本,授予写权限或放宽受众范围前请先阅读 [Hub 安全](/docs/hub/security)。
|
||||
|
||||
| 过滤条件 | 适用于 | 匹配内容 |
|
||||
| ------------------ | ------------------------------ | ------------------------------------------------------------- |
|
||||
|
||||
@@ -61,7 +61,9 @@ paseo hub deploy --dry-run
|
||||
paseo hub deploy
|
||||
```
|
||||
|
||||
From an allowed Linear account, post an issue comment such as `/paseo summarize this request`. Hub matches the prefix, runs the agent on `devbox`, and posts the reply as a comment on that Linear issue. When Hub runs over HTTPS, the reply includes an **Open in Paseo** link. Check [Activity](/docs/hub/activity) to inspect the run.
|
||||
From an allowed Linear account, post an issue comment such as `/paseo summarize this request`. Hub matches the prefix, runs the agent on `devbox`, and posts the reply as a comment on that Linear issue.
|
||||
|
||||
When Hub runs over HTTPS, the reply includes an **Open in Paseo** link. Check [Activity](/docs/hub/activity) to inspect the run.
|
||||
|
||||
## Start work when an issue enters scope
|
||||
|
||||
|
||||
@@ -59,7 +59,9 @@ paseo hub deploy --dry-run
|
||||
paseo hub deploy
|
||||
```
|
||||
|
||||
使用允许的 Linear 账号发表一条 issue 评论,例如 `/paseo summarize this request`。Hub 会匹配前缀、在 `devbox` 上运行 Agent,并将回复作为评论发布到该 Linear issue。Hub 运行在 HTTPS 下时,回复会附带 **Open in Paseo** 链接。在 [Activity](/docs/hub/activity) 中可以查看运行记录。
|
||||
使用允许的 Linear 账号发表一条 issue 评论,例如 `/paseo summarize this request`。Hub 会匹配前缀、在 `devbox` 上运行 Agent,并将回复作为评论发布到该 Linear issue。
|
||||
|
||||
Hub 运行在 HTTPS 下时,回复会附带 **Open in Paseo** 链接。在 [Activity](/docs/hub/activity) 中可以查看运行记录。
|
||||
|
||||
## 在 issue 进入范围时开始工作 {#start-work-when-an-issue-enters-scope}
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ Set `run.background: true` to create a background Paseo workspace that stays hid
|
||||
|
||||
## Timing, overlap, and recovery
|
||||
|
||||
- Hub evaluates schedules against the selected timezone's local wall clock. A local time skipped by a daylight-saving jump is skipped. A repeated local time runs once at its earlier occurrence. Use `UTC` for fixed elapsed-time intervals across daylight saving.
|
||||
- Hub evaluates schedules against the selected timezone's local wall clock, skipping times jumped by daylight saving and running repeated times once at their earlier occurrence. Use `UTC` for fixed elapsed-time intervals across daylight saving.
|
||||
- While a scheduled run is still active, Hub skips newly due occurrences for that trigger instead of stacking parallel runs. Once the active run completes or fails, the next future occurrence resumes. Separate triggers can still run at the same time on the same daemon.
|
||||
- After Hub downtime, Hub dispatches one catch-up run for the earliest missed occurrence and then advances to the next future occurrence. It does not replay every missed tick.
|
||||
- Include `${{ paseo.context }}` in `run.prompt` to pass `schedule.trigger_id`, `schedule.scheduled_at` (UTC), and `schedule.timezone`.
|
||||
|
||||
@@ -77,7 +77,7 @@ run:
|
||||
|
||||
## 触发时机、重叠与恢复 {#timing-overlap-and-recovery}
|
||||
|
||||
- Hub 按所选时区的本地挂钟时间计算计划。夏令时跳过的本地时间会被跳过;夏令时回拨重复的本地时间只在较早一次运行。如需跨夏令时保持固定时长间隔,请使用 `UTC`。
|
||||
- Hub 按所选时区的本地挂钟时间计算计划,跳过夏令时跳过的本地时间,并在夏令时回拨重复时仅在较早一次运行。如需跨夏令时保持固定时长间隔,请使用 `UTC`。
|
||||
- 当该触发器的某次定时运行仍在进行时,Hub 会跳过新到期的触发,不会堆叠并行运行。当前运行完成或失败后,下一次未来触发会恢复。不同触发器仍可在同一台 daemon 上同时运行。
|
||||
- Hub 停机恢复后,会对最早错过的一次执行派发 1 次补跑,然后直接推进到下一次未来触发,不会逐条重放所有错过的计划。
|
||||
- 在 `run.prompt` 中包含 `${{ paseo.context }}` 可以传入 `schedule.trigger_id`、`schedule.scheduled_at`(UTC)和 `schedule.timezone`。
|
||||
|
||||
@@ -48,7 +48,11 @@ run:
|
||||
|
||||
## Filters and prompt text
|
||||
|
||||
Slack filters use IDs, not display names or connection slugs. `from_users` is required and matches the sender's Slack member ID. `workspace` matches the Slack team ID and `channels` limits which channels can trigger the run. `pattern` requires a prefix after the mention (`contains` is its legacy alias with the same prefix behavior). All filters compose with AND.
|
||||
Slack filters use IDs, not display names or connection slugs. All filters compose with AND:
|
||||
|
||||
- `from_users` is required and matches the sender's Slack member ID.
|
||||
- `workspace` matches the Slack team ID and `channels` limits which channels can trigger the run.
|
||||
- `pattern` requires a prefix after the mention (`contains` is its legacy alias with the same prefix behavior).
|
||||
|
||||
`${{ paseo.prompt }}` contains the complete received message text. If you declare `inputs` on the trigger, Hub parses leading `key=value` tokens after the mention into `${{ paseo.inputs }}`:
|
||||
|
||||
|
||||
@@ -46,7 +46,11 @@ run:
|
||||
|
||||
## 过滤条件与提示词文本 {#filters-and-prompt-text}
|
||||
|
||||
Slack 过滤条件使用 ID,而不是显示名称或连接 slug。`from_users` 为必填项,匹配发送者的 Slack 成员 ID。`workspace` 匹配 Slack Team ID,`channels` 限制可触发运行的频道。`pattern` 要求提及之后紧跟指定前缀(`contains` 是其旧别名,前缀行为相同)。所有过滤条件按逻辑与组合。
|
||||
Slack 过滤条件使用 ID,而不是显示名称或连接 slug。所有过滤条件按逻辑与组合:
|
||||
|
||||
- `from_users` 为必填项,匹配发送者的 Slack 成员 ID。
|
||||
- `workspace` 匹配 Slack Team ID,`channels` 限制可触发运行的频道。
|
||||
- `pattern` 要求提及之后紧跟指定前缀(`contains` 是其旧别名,前缀行为相同)。
|
||||
|
||||
`${{ paseo.prompt }}` 包含收到的完整消息文本。如果你在触发器上声明了 `inputs`,Hub 会将提及之后紧跟的 `key=value` 头部解析到 `${{ paseo.inputs }}`:
|
||||
|
||||
|
||||
@@ -141,13 +141,15 @@ Paseo never stores or transmits provider API keys. Agents run in your user conte
|
||||
|
||||
## Hub identities and credentials
|
||||
|
||||
Hub CLI login and daemon enrollment are separate identities. `paseo hub login [origin]` stores a durable organization-scoped human credential in a private file under `PASEO_HOME`, keyed by the normalized Hub origin. A stored credential is never sent to another origin. Protect `PASEO_HOME` as sensitive local state.
|
||||
Hub CLI login and daemon enrollment are separate identities. `paseo hub login [origin]` stores a durable organization-scoped credential in a private file under `PASEO_HOME`, keyed by the normalized Hub origin.
|
||||
|
||||
Hub CLI credentials are bearer secrets. Remote Hub origins must use HTTPS; cleartext HTTP is accepted only for loopback development origins (`localhost`, `127.0.0.1`, and `[::1]`).
|
||||
A stored credential is never sent to another origin, so protect `PASEO_HOME` as sensitive local state. Hub CLI credentials are bearer secrets, and remote Hub origins must use HTTPS (cleartext HTTP is accepted only on `localhost`, `127.0.0.1`, and `[::1]`).
|
||||
|
||||
`paseo hub connect [origin]` uses that credential, or an explicit API key, only to request a short-lived one-time enrollment token. The daemon exchanges the token and retains its own independently generated relationship credential. Logging out of the CLI does not silently remove daemon authority. Interactive logout completes any accepted same-origin daemon disconnection before deleting the login. In JSON and noninteractive use, `logout` never prompts or disconnects; pass `--disconnect-daemon` only when automation intends to remove both identities.
|
||||
`paseo hub connect [origin]` uses your CLI login or an API key only to request a short-lived one-time enrollment token. The daemon exchanges that token for its own independent relationship credential.
|
||||
|
||||
`--api-key` and `PASEO_HUB_API_KEY` override stored login without being persisted. Prefer environment or secret-manager injection for automation, and avoid command-line flags when local process listings or shell history are visible to other users.
|
||||
Logging out of the CLI does not silently remove daemon authority. Interactive `logout` asks whether to disconnect a same-origin daemon before deleting the login, while JSON and non-interactive logouts require `--disconnect-daemon` to remove both identities.
|
||||
|
||||
`--api-key` and `PASEO_HUB_API_KEY` override stored login without being persisted. Prefer environment variables or secret-manager injection for automation, and avoid command-line flags when local process listings or shell history are visible to other users.
|
||||
|
||||
## Recommendations
|
||||
|
||||
|
||||
@@ -138,13 +138,15 @@ Paseo 从不保存或传输 Provider API 密钥。Agent 在你的用户上下文
|
||||
|
||||
## Hub 身份与凭据 {#hub-identities-and-credentials}
|
||||
|
||||
Hub CLI 登录和 daemon 注册是两个独立的身份。`paseo hub login [origin]` 会在 `PASEO_HOME` 下的一个私有文件中保存一个持久的、组织范围的个人凭据,以规范化后的 Hub 地址为键。保存的凭据从不会发送到其他地址。请把 `PASEO_HOME` 当作敏感的本地状态加以保护。
|
||||
Hub CLI 登录和 daemon 注册是两个独立的身份。`paseo hub login [origin]` 会在 `PASEO_HOME` 下的私有文件中保存持久的组织级凭据,以规范化后的 Hub 地址为键。
|
||||
|
||||
Hub CLI 凭据是 bearer 密钥。远程 Hub 地址必须使用 HTTPS;只有回环地址的开发环境(`localhost`、`127.0.0.1` 和 `[::1]`)才接受明文 HTTP。
|
||||
保存的凭据从不会发送到其他地址,请将 `PASEO_HOME` 作为敏感的本地状态加以保护。Hub CLI 凭据是 bearer 密钥,远程 Hub 地址必须使用 HTTPS(仅 `localhost`、`127.0.0.1` 和 `[::1]` 接受明文 HTTP)。
|
||||
|
||||
`paseo hub connect [origin]` 只用这个凭据(或显式提供的 API 密钥)申请一个短期有效的一次性注册令牌。daemon 用这个令牌完成交换,并保留它自己独立生成的关系凭据。退出 CLI 登录不会悄悄移除 daemon 的权限。交互式退出会先完成已确认的同一地址 daemon 断开,再删除登录。在 JSON 和非交互使用中,`logout` 从不提示也不断开;只有当自动化打算同时移除两个身份时,才传入 `--disconnect-daemon`。
|
||||
`paseo hub connect [origin]` 只用 CLI 登录或 API 密钥申请短期有效的一次性注册令牌。daemon 用该令牌换取自己独立的关系凭据。
|
||||
|
||||
`--api-key` 和 `PASEO_HUB_API_KEY` 会覆盖已保存的登录,但不会被持久化。用于自动化时,优先通过环境变量或密钥管理器注入;当本地进程列表或 shell 历史对其他用户可见时,避免使用命令行参数。
|
||||
退出 CLI 登录不会悄悄移除 daemon 权限。交互式 `logout` 会在删除登录前询问是否断开同一地址的 daemon,而 JSON 和非交互式退出需要传入 `--disconnect-daemon` 才会移除两个身份。
|
||||
|
||||
`--api-key` 和 `PASEO_HUB_API_KEY` 会覆盖已保存的登录而不会持久化。用于自动化时,优先通过环境变量或密钥管理器注入,并在本地进程列表或 shell 历史对其他用户可见时避免使用命令行参数。
|
||||
|
||||
## 建议 {#recommendations}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user