- pin @start9labs/start-sdk 3.0.3, regenerate the lock, drop the toolchain devDependencies and scripts the SDK supplies, point .prettierrc at the SDK's shared config - file models use z.looseObject - empty sdk.Dependencies builder passed to buildManifest and setupInit; drop the manifest dependencies field - sync workflows to the package template on main (ready_for_review, pr-retarget.yml) - Verbose Logging's description says what it logs - resync AGENTS.md boilerplate and trim its repo notes Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.7 KiB
AGENTS.md
This is a StartOS service-package repository — it builds a .s9pk for StartOS.
Develop it inside a StartOS packaging workspace created by start-cli s9pk init-workspace,
which provides the packaging guide and agent context one level up. If you're reading this in a
bare clone with no workspace, the full guide is at https://docs.start9.com/packaging.
Start every task at the recipe index — ../start-technologies/projects/start-sdk/docs/src/recipes.md
(or https://docs.start9.com/packaging/recipes.html). It maps an intent ("prompt the user to create
admin credentials", "expose a web UI") to the constructs, the reference pages, and a named production
package to copy. Find the recipe before you read this package's neighbours: a package you reach by
grepping may be non-conformant, and the recipe outranks it.
Freshly scaffolded? Work the New Package Checklist (or https://docs.start9.com/packaging/new-package-checklist.html) from top to bottom. It is a guide page, not a file in this repo — read it, don't copy it in.
Keep README.md (technical reference for an AI support or administering agent) and
instructions.md (end-user docs) in sync with your changes. This file restates neither:
whoever changes the package has both, so it carries only what they don't — repo mechanics,
a change that looks right and is not, where the next thing gets added, a naming trap, a
build or test invocation particular to this repo.
Fix a defect you spot rather than reporting it — you have the package open and the
context to be sure. File a GitHub issue on this repo only when the call isn't yours to
make: you can't pin the cause down, two defensible fixes exist, or it's too large to ride on
the work in hand. An open issue is a report, not a queue — implement one when you're asked
to or when it's labelled Approved, then close it with Closes #<n>.
Don't record work in the repo instead: no TODO.md, no NOTES.md, no PLAN.md. What you
verified, tried, and decided belongs in the commit message and the PR body.
This repo
- Put package-owned settings in
store.json, never inconfig.json— the proxy rewritesconfig.jsonwhole when a key is saved on the Status Page. - Don't set
PPQ_API_KEY— the proxy's own key store must stay the key's only owner, so the action and the Status Page write the same key. - A blank key field keeps the saved key; don't "fix" it to clear on empty — it is how the action toggles logging without re-entering the key.
- Default branch is
main, notmaster. Keepmainin every workflow when resyncing them from the template.