Repository navigation
docs(runs): Pi + Gentle Shell agent; runs and automations only with installed agents - #177
Merged
Merged
Conversation
Document the third run agent, pi_gentle (Pi + Gentle Shell), and the rule that runs and automations only accept an agent the workspace has installed (cloud-api #345, cloud-ui #158, nan-cli #47). - runs (EN/ES): new "Pick the agent" section (labels, values, what each needs, 409 agent_not_installed with param agent, CLI exit 4, run_agents), the Agent form row, --agent pi|pi_gentle|hermes with a pi_gentle example and the 0.1.29 requirement, and the API 409 example. - automations, pr-gatekeeper, workspaces (EN/ES): prerequisites, the Agent row, the run sentence and a link from gentle-shell to Pick the agent. - openapi.json: pi_gentle in every agent enum, Workspace.run_agents with examples, agent_not_installed examples (param agent) on both run 409s. - Tests: enum/label/run_agents/409 checks in openapiRuns.test.ts and a new runAgentsDocs.test.ts with EN/ES parity. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Hermes row: installed from the Software panel (no backend-only wording). - Pick the agent covers the automation editor: empty state, (not installed), workspace switch; the automations Agent cell is shorter and links there. - run_agents description: covers automation runs and drops the ambiguous 'any other agent' wording. - Tighter tests: the agent-field sentence, (not installed), cell length. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Docs for the third run agent, Pi + Gentle Shell (
pi_gentle), and the rule that runs and automations only accept an agent the workspace has installed. Shipped in helmcode/nan-cloud-api#345 (0.8.258); UI in helmcode/nan-cloud-ui#158; CLI in helmcode/nan-cli#47 (0.1.29).EN and ES:
--agent/agentvalue and what the workspace needs (Pi; Pi and gentle-shell; Hermes chosen or installed and switched on). It explains the installed-only rule: the portal lists only the workspace's agents, the CLI and the API get409 agent_not_installed(param: "agent", CLI exit 4), and an automation keeps a removed agent but its runs are refused. It also points scripts atrun_agents. The intro, the prerequisites, the Agent form row, the--agent pi|pi_gentle|hermesflag row (with the 0.1.29 requirement), api_gentleCLI example, and the API section (acceptedagentvalues plus the exact 409 envelope) are updated.agent_not_installed).pi_gentlein every agent enum (CreateRunRequest,Run,RunEventDataStarted,Automation) with label descriptions. AddsWorkspace.run_agents(enum, display order, the requirements) and puts it in both workspace examples. Adds anagent_not_installedexample withparam: "agent"to the 409 ofPOST /v1/runsandPOST /v1/automations/{id}/runs. The Runs tag description is updated too.Shapes come from cloud-api origin/main:
runs.AgentName/AgentNotInstalled,software.RunAgentIDs/runAgentRequires, andworkspace.Workspace.RunAgents.Tests
src/lib/openapiRuns.test.ts: the enum assertion is updated, plus a new block. It checks every agent enum is exactlypi, pi_gentle, hermes, that no schema still lists onlypi/hermes, the label descriptions,run_agentsplacement, enum and examples, and the two 409 examples (exact envelope, validated againstError). The validator must accept all three agents and rejectpi-gentle,gentle_shelland similar values.src/tests/layouts/runAgentsDocs.test.tscovers EN and ES. It checks the agent table rows and order, where the section sits, the installed-only rule (409,agent, exit 4,run_agents), the form row, the flag row, 0.1.29 and thepi_gentleexample. The 409 JSON in the guide must equal the reference example. It also checks the automations, PR gatekeeper and workspaces lines and that EN and ES match.npm test: 81 files, 2084 tests pass.npm run buildpasses.Deploy notes
No VERSION file (Cloudflare deploy on merge).
--agent pi_gentleneeds nan-cli 0.1.29, so merge after helmcode/nan-cli#47 is released. The portal labels match helmcode/nan-cloud-ui#158, so merge after that one too.🤖 Generated with Claude Code