Lead with the browser-to-CLI onboarding journey, document the generated starter bundle, and align guided setup with available Hub connections and daemon-reported runtime defaults.
5.4 KiB
title, description, nav, order, category
| title | description | nav | order | category |
|---|---|---|---|---|
| Hub configuration | Configuration bundles, GitHub sync, CLI deployment, and revisions. | Configuration | 70 | Hub |
Hub configuration
A project configuration is one versioned bundle:
.paseo/
├── hub.yml
└── workflows/
├── <workflow>.yml
└── partials/
└── <partial>.md
hub.yml owns named environments and agents. Each direct-child workflow file owns one trigger and its ordered inline steps. Prompt partials referenced by those workflows live below workflows/partials/. Workflow discovery is fixed by convention; there is no manifest or include list.
single-repo-team-bot is a complete bundle in this shape: Discord, Slack, and GitHub workflows running a classifier and a worker on shared partials. Copy .paseo/ into your repository and replace the placeholders its README lists.
Generated starter bundle
paseo hub init, and the guided setup that interactive paseo hub login offers, write two files for the directory you run them in:
# .paseo/hub.yml
environments:
my-macbook:
kind: daemon
daemon: my-macbook
cwd: /Users/you/code/your-repo
agents:
starter:
provider: codex
model: gpt-5
mode: full-access
The environment is named after the connected daemon and points at the directory setup ran in. provider, model, and mode are the runtime you chose from what that daemon reported, so the starter agent is a complete selection before its first run. mode is omitted for a provider that exposes none.
# .paseo/workflows/slack-help.yml
name: slack-help
on: slack.mention
max_runtime: 2h
filters:
workspace: T01234567
from_users:
- U01234567
steps:
- id: work
environment: my-macbook
max_runtime: 90m
idle_timeout: 10m
agent: starter
prompt:
- text: |
Answer with hub.reply, then complete this request and call hub.finish_execution when done.
<user-prompt>
${{ paseo.prompt }}
</user-prompt>
allow_outputs:
- type: slack.reply
max: 1
required: true
filters carries the identity each provider matches on: the Slack team and member ID above, the Discord guild and user ID for a Discord starter, and owner/name plus your login for GitHub.
A Discord starter is discord-help.yml and carries discord.reply, the counterpart of the slack.reply above. A GitHub starter is github-help.yml and declares no reply output; GitHub has no reply capability, so a step that must comment needs a github block instead.
The generated workflow allows one user in one workspace. Read Hub security before widening it.
Sources
A configuration comes from one source:
- GitHub source: the complete
.paseobundle on the repository's default branch. - Manual source: source files edited and activated in the dashboard.
- CLI/API install: a complete bundle sent with organization authority.
The Configuration tab shows the active revision, source files, and latest synchronization attempt.
Deploy from the CLI
Run from the project root:
paseo hub login https://hub.example.com
paseo hub deploy -p my-project --dry-run
paseo hub deploy -p my-project
Both commands discover .paseo/hub.yml, every direct .paseo/workflows/*.yml file, and each referenced file below .paseo/workflows/partials/. Files are sent in deterministic path order through the same bundle request. Dry-run calls server-side validation and does not create or activate a revision.
The CLI rejects missing resource or workflow files, .yaml workflow extensions, nested workflow files, unsafe partial paths, symlinked bundle paths, and unreadable files before contacting Hub. Errors name paths but never print file contents or credentials.
Origin precedence:
--hubPASEO_HUB_URL- Active stored login
https://hub.paseo.sh
Credential precedence:
--api-keyPASEO_HUB_API_KEY- Stored login for the exact resolved origin
Flags and environment keys are not stored. Endpoint and credential behavior is unchanged between deploy and dry-run.
GitHub sync
A push to the configuration repository's default branch starts a sync:
- Hub discovers the canonical bundle at that exact commit.
- It parses every source file and resolves prompt partials.
- It validates named resources, expressions, connections, and daemon availability.
- On success, the new immutable revision becomes active.
Sync now performs the same operation on demand. Failures retain their source path and authored field. A failed sync never replaces the active revision.
Revisions and source changes
Revisions retain the exact authored files needed to inspect or redeploy them. Rolling back activates an earlier revision. The next valid GitHub push activates a new revision again.
GitHub-backed configuration is read-only in the dashboard. Switching to manual preserves source documents; it does not collapse the bundle into one generated file.
The configuration repository may differ from repositories named by filters.repo. Protect it because changing the bundle can select connections, daemons, working directories, agents, and outputs. See Hub security.
Next: the configuration reference and workflow examples.