This repository has been archived on 2026-04-03. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
core/packages/README.md
Jeffrey Smith f0dd43144e rebrand: Switchboard Core → Armature
- Rename Go module switchboard-core → armature (155+ files)
- Rename Docker image → gobha/armature
- Rename K8s resources, secrets, deployments
- Rename Prometheus metrics switchboard_* → armature_*
- Rename env vars SWITCHBOARD_ADMIN_* → ARMATURE_ADMIN_*
- Rename DB names switchboard_core* → armature*
- Update all frontend branding, notification templates, docs
- Update CI scripts, e2e tests, Keycloak realm, nginx conf
- Rename scripts/switchboard-ca.sh → scripts/armature-ca.sh
- Rename k8s/switchboard.yaml → k8s/armature.yaml
- Rename chart alerting/dashboard files
- Fix: DockerHub push uses env: binding for secret injection
- Helm chart updated (name, labels, template functions, dashboard, alerting)
- Replace favicon/icon assets with Armature brand

No functional changes. Pure mechanical rename + CI fix.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 21:39:58 +00:00

46 lines
1.3 KiB
Markdown

# Packages
Installable `.pkg` archives for Chat Armature. Each subdirectory is a
package — either a surface (routable UI), an extension (hooks/tools/pipes),
or both (`full` type).
v0.28.7: Renamed from `surfaces/`. The `.pkg` format replaces `.surface`.
See [docs/PACKAGES.md](../docs/PACKAGES.md) for the complete manifest schema and authoring guide.
For workflow packages, see [docs/WORKFLOW-PACKAGES.md](../docs/WORKFLOW-PACKAGES.md).
## Building
```bash
./packages/build.sh # build all → dist/*.pkg
./packages/build.sh icd-test-runner # build one
```
## Installing
```bash
curl -X POST http://localhost:8080/api/v1/admin/packages/install \
-H "Authorization: Bearer $TOKEN" \
-F file=@dist/icd-test-runner.pkg
```
Or use the admin UI → System → Packages → Upload.
## Archive Format
A `.pkg` file is a zip containing:
```
manifest.json — required (must have "id" and "title")
js/ — optional JavaScript assets
css/ — optional stylesheets
assets/ — optional images, icons, etc.
```
The manifest `type` field determines behavior:
- `surface` (default) — routable page at `/s/:slug`
- `extension` — hooks, tools, and/or pipe filters
- `full` — both a surface and an extension
`.surface` archives are accepted as a backward-compatible alias.