Files
sandwich-hime-tooling/README.md
T
gamertan 6df87bc958 feat: publish Sandwich Hime tooling preview
Publish the exact sanitized Agent Skill and VS Code preview source tree with independent license boundaries, deterministic provenance manifests, and no private development history. Material design and implementation assistance was provided by OpenAI Codex.

Signed-off-by: Cole Speelman <crspeelman@gmail.com>
2026-08-12 20:33:51 -04:00

74 lines
2.8 KiB
Markdown

<!-- SPDX-License-Identifier: AGPL-3.0-only -->
# Sandwich Hime tooling
Portable agent guidance and editor packaging for
[Sandwich Hime](https://sandwichhime.com/), an HTML-first, ahead-of-time
template engine for Go.
This repository contains:
- `skills/sandwich-hime`: a portable 0BSD Agent Skill for safe `.sando`
authoring, composition, migration, review, debugging, and security work.
- `editors/vscode`: the AGPL-3.0-only VS Code preview client for Hime-san's
reusable Language Server Protocol implementation.
Language intelligence belongs to the canonical Hime-san compiler. The editor
starts one `himesan lsp --stdio` process per trusted workspace folder and adds
syntax highlighting, snippets, explicit project commands, and lifecycle UX.
It does not download, install, upgrade, or phone home.
## Preview compatibility
- Agent Skill `skill/v0.1.0`: Hime-san `v1.0.0-beta.1` and newer.
- VS Code `0.1.0-preview.1`: requires Hime-san `v1.0.0-beta.2` and its
advertised `lsp-stdio` feature.
- Sando runtime remains independently versioned; Beta 2 tooling is compatible
with `sando/v1.0.0-beta.1`.
Exact pinned installation order:
```sh
go get gamertan.com/sandwich-hime/sando@v1.0.0-beta.1
go install gamertan.com/sandwich-hime/cmd/himesan@v1.0.0-beta.2
```
## Install the portable skill
Download `sandwich-hime-skill-v0.1.0.zip` and `SHA256SUMS` from the canonical
Gitea `skill/v0.1.0` release, verify the checksum, and extract the single
`sandwich-hime` folder into one of these locations:
- Codex user scope: `$CODEX_HOME/skills/sandwich-hime` (normally
`~/.codex/skills/sandwich-hime`).
- Open Agent Skills project scope: `.agents/skills/sandwich-hime`.
The folder itself is the portable unit: `SKILL.md`, its 0BSD `LICENSE`, agent
metadata, and the two routed references. Do not install the whole tooling
repository as a skill. Restart or reload the agent host after extraction if it
does not discover new skills dynamically.
## Install the editor preview
The preview is intentionally a Gitea release asset, not a Marketplace or Open
VSX listing. Verify its checksum, then run:
```sh
code --install-extension sandwich-hime-0.1.0-preview.1.vsix
```
The extension supplies syntax highlighting without trust. Its executable
features require a trusted workspace and the separately installed Beta 2
compiler; it never downloads Hime-san for you.
## Canonical project
Source, issues, and contributions live on
[Gamertan Gitea](https://gitea.speelman.ca/gamertan/sandwich-hime-tooling).
Any GitHub repository is a read-only, fresh-history discovery snapshot. The
private development repository and its history are not publication surfaces.
Repository infrastructure and editor code are AGPL-3.0-only. The complete
`skills/sandwich-hime` subtree is offered separately under 0BSD; see its local
`LICENSE`.