Mohamed BoudraandGitHub
05a0cabc07
* feat(hub): deploy canonical workflow bundles Keep CLI deployment aligned with Hub's authored bundle boundary so validation and activation receive the same deterministic source files. Public documentation now teaches that boundary as the only configuration format. * test(hub): assert validation diagnostics directly * refactor(hub): deepen HTTP client module * feat(hub): validate named agent configurations * docs(hub): align Claude mode example
104 lines
2.8 KiB
Markdown
104 lines
2.8 KiB
Markdown
---
|
|
title: Hub quickstart
|
|
description: Connect Hub, create a project, and run a workflow from a GitHub comment.
|
|
nav: Quickstart
|
|
order: 61
|
|
category: Hub
|
|
---
|
|
|
|
# Hub quickstart
|
|
|
|
## 1. Connect GitHub and a daemon
|
|
|
|
Open **Connections** in Hub and connect the GitHub account or organization whose repositories you use. On the machine that will run agents:
|
|
|
|
```sh
|
|
paseo hub login https://your-hub.example.com
|
|
paseo hub connect
|
|
```
|
|
|
|
Approve the browser login. See [Daemons](/docs/hub/daemons) for the separation between your CLI login and the daemon relationship.
|
|
|
|
## 2. Create a project
|
|
|
|
Open **Projects → New project**. In **Configuration**, choose the repository that will hold the configuration and select **Use for configuration**.
|
|
|
|
## 3. Add the bundle
|
|
|
|
Create these files:
|
|
|
|
```text
|
|
.paseo/
|
|
├── hub.yml
|
|
└── workflows/
|
|
└── github-help.yml
|
|
```
|
|
|
|
`.paseo/hub.yml` names project-wide resources:
|
|
|
|
```yaml
|
|
environments:
|
|
dev:
|
|
kind: daemon
|
|
daemon: my-daemon
|
|
cwd: /Users/you/code/your-repo
|
|
agents:
|
|
codex:
|
|
provider: codex
|
|
mode: full-access
|
|
```
|
|
|
|
`.paseo/workflows/github-help.yml` contains one trigger and its ordered steps:
|
|
|
|
```yaml
|
|
name: github-help
|
|
on: github.issue_comment
|
|
max_runtime: 2h
|
|
filters:
|
|
repo: yourname/your-repo
|
|
contains: "@paseo"
|
|
from_users: [your-github-login]
|
|
steps:
|
|
- id: work
|
|
environment: dev
|
|
max_runtime: 90m
|
|
idle_timeout: 10m
|
|
agent: codex
|
|
prompt:
|
|
- text: |
|
|
Complete this request and call hub.finish_execution when done.
|
|
|
|
<user-prompt>
|
|
${{ paseo.prompt }}
|
|
</user-prompt>
|
|
```
|
|
|
|
`daemon` is the daemon slug shown by Hub. `cwd` is a directory on that machine. `${{ paseo.prompt }}` is the normalized request text after the provider marker and declared input headers are removed.
|
|
|
|
Workflow files are discovered as direct `.yml` children of `.paseo/workflows/`. You do not list them in `hub.yml`.
|
|
|
|
## 4. Validate and deploy
|
|
|
|
Push the files to the configuration repository's default branch. Hub fetches the complete bundle at that commit, validates it, and activates a revision. A failed sync leaves the previous revision active.
|
|
|
|
You can validate or deploy the same local bundle from its project root:
|
|
|
|
```sh
|
|
paseo hub deploy -p your-project --dry-run
|
|
paseo hub deploy -p your-project
|
|
```
|
|
|
|
Dry-run performs the same discovery and server-side validation without recording or activating a revision. See [Configuration](/docs/hub/configuration) for credentials, diagnostics, and GitHub sync.
|
|
|
|
## 5. Trigger it
|
|
|
|
Comment from the account in `from_users`:
|
|
|
|
```text
|
|
@paseo have a look at this
|
|
```
|
|
|
|
Open the project's **Activity** tab to see routing and execution. If nothing runs, use the [Activity checklist](/docs/hub/activity).
|
|
|
|
Before widening the allowlist or granting write authority, read [Hub security](/docs/hub/security).
|