Skip to content

feat: short config_inputs labels, explanations in help (needs protoAgent#3631 released) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabry1985 merged 4 commits into from
Sep 26, 2026
Merged

feat: short config_inputs labels, explanations in help (needs protoAgent#3631 released) #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1c8dad
feat: short config_inputs labels with the explanation in `help`
mabry1985 Sep 26, 2026
e0f2b65
Merge remote-tracking branch 'origin/main' into feat/config-inputs-help
mabry1985 Sep 26, 2026
692b13b
chore: verified against protoAgent 0.183.0; state the core floor for …
mabry1985 Sep 26, 2026
a7851d7
docs: the last stale "Configure toggle" comment names the set-up switch
mabry1985 Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ unauthenticated.

**Writes are off** (`github.write: false`): the write tools (create/edit/close/merge issues
and PRs, comments, labels, assignees) aren't even bound. To let the agent post *when you ask
it to*, flip the Configure step's GitHub toggle at create time, or later set:
it to*, flip *Allow GitHub writes* on the set-up step at create time, or later set:

```yaml
github:
Expand Down Expand Up @@ -117,12 +117,14 @@ what an older core misses:
- the terminal and github plugins need 0.27.0 (console views);
- `show_code` / the code pane needs 0.179.0, `run_auto_approve` 0.177.0, `open_in_editor`
0.176.0.
- the set-up step's explanation lines (`help:` on `config_inputs`) need 0.183.0; an older core
ignores `help` and shows only the short labels (*Start in a local repo*, *Allow GitHub writes*).

## First run

**The Configure step asks two optional questions.** First, *a local repo to start in* (an
absolute path): it's registered as a managed project the agent can reach, and the terminal
opens there. Second, whether the *GitHub write tools* bind (off by default; see above).
**The set-up step asks two optional questions** (after you pick Engineer). First, *Start in
a local repo* (a folder on the agent's machine): it's registered as a managed project the agent can reach, and the terminal
opens there. Second, *Allow GitHub writes* — whether the GitHub write tools bind (off by default; see above).
Leave the repo blank and onboard from chat instead:

> onboard github.com/owner/repo and give me the repo card
Expand All @@ -140,7 +142,7 @@ aren't asked:
| `filesystem.run_auto_approve` | read-only git: `git status`, `git diff`, `git log`, `git show`, `git branch --show-current` | same |
| `filesystem.code_pane` | `true`: binds `show_code` and the console's Code pane | same (Tools ▸ Filesystem ▸ Shell & filesystem tools) |
| `filesystem.editor_command` | `zed`. Use `code -g` for VS Code, `cursor -g` for Cursor, or empty to unbind `open_in_editor` | same |
| `github.write` | `false`: read tools only | Settings ▸ GitHub, or the Configure toggle |
| `github.write` | `false`: read tools only | Settings ▸ GitHub, or the *Allow GitHub writes* switch at create time |
| `friction.issue_repo` | empty (copy to clipboard). Point it at `protoLabsAI/protoAgent` if you file harness friction upstream, **never** at the repo you're working in | Settings ▸ Plugins (Friction) |
| `friction.escape_hatch_exempt` | `[run_command]`, the persona's main instrument, not an escape hatch | same |
| model | **unset**: uses your host's model connection | Settings ▸ Host / the agent's model picker |
Expand Down
26 changes: 19 additions & 7 deletions protoagent.bundle.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@
# 0.180.0 (#3618) ignored the marker and reported that Windows-only dep MISSING on
# macOS/Linux;
# * `filesystem.code_pane` (show_code) is 0.179.0+, run_auto_approve 0.177.0+,
# open_in_editor 0.176.0+.
# open_in_editor 0.176.0+;
# * the `help:` line under each `config_inputs` field renders on 0.183.0+; older
# cores ignore `help` and show the short label alone.
#
# FIRST-RUN SETUP — two optional Configure answers (core >= 0.144.0 renders
# FIRST-RUN SETUP — two optional set-up answers (core >= 0.144.0 renders
# `config_inputs:`): a local checkout to start in — written to `terminal.cwd` (the
# terminal opens there) and, because it is flagged `project: true`, registered as a
# managed project (ADR 0095) the agent's filesystem tools can reach; leave it blank and
Expand Down Expand Up @@ -68,7 +70,7 @@ description: >-

# The core version this pin set was last verified against (ADR 0049) — metadata, not
# enforced. See CORE FLOOR above.
verified_against: 0.182.0
verified_against: 0.183.0

plugins:
- { id: engineer, builtin: true } # the navigator skills: repo-onboard + debug-loop (off for every other agent)
Expand All @@ -80,11 +82,21 @@ plugins:

enabled: [engineer, craft, friction, delegates, terminal, github] # suggested turn-on list

# Create-time setup prompts (#2934, core >= 0.144.0) — the Configure step in the Setup
# Create-time setup prompts (#2934, core >= 0.144.0) — the set-up step in the Setup
# Wizard and the New Agent panel renders these and writes each answer at its key.
# `label` is the short field name; `help` is the explanation line under it (rendered by
# core >= 0.183.0; older cores ignore it and show the label alone).
config_inputs:
- { key: terminal.cwd, label: "A local repo to start in (absolute path; optional — it is registered as a project and the terminal opens there)", type: path, project: true }
- { key: github.write, label: "Let the agent write to GitHub when you ask (open/comment/label/merge issues and PRs). Off = read-only", type: boolean, default: false }
- key: terminal.cwd
label: "Start in a local repo"
help: "Registered as a managed project the agent can reach, and the terminal opens there."
type: path
project: true
- key: github.write
label: "Allow GitHub writes"
help: "Lets the agent open, comment on, label and merge issues and PRs when you ask. Off = read-only."
type: boolean
default: false

config: # recommended defaults (you apply them)
# Hands-on coding on the operator's machine: read and run freely, with a per-command
Expand Down Expand Up @@ -123,7 +135,7 @@ config: # recommended defaults (you
# in Settings ▸ GitHub). READ-ONLY by default: issues, PRs, diffs, CI status and repo
# files — for getting up to speed and reading the CI failure you're debugging. The
# navigator never posts, pushes, labels or merges on its own; `write: true` (the
# Configure toggle above, or Settings ▸ GitHub) binds the write tools for when you ask.
# *Allow GitHub writes* switch above, or Settings ▸ GitHub) binds the write tools for when you ask.
# No `default_repo`: the plugin derives repos from the projects you onboard.
# Terminal (v0.9.0+): split panes, login shells, and agent terminal tools gated by
# `agent_access`. READ for a navigator: the agent can list and read your terminals ("what's
Expand Down
Loading