Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ versioning. Tool versions (this file) are independent of the typed-resource
TypeFerence is an experimental reference implementation; pre-1.0 versions make no
compatibility promises between minor versions.

## [0.0.4] - 2026-07-15

### Added

- **CLI usage section** in `README.md` — a self-contained command reference
(`validate`, `build`, `inspect`, `diff`, `eval`, `equivalence pack`/`score`,
`version`) for anyone running the binary from a release archive rather than
a full clone; `README.md` ships in every release archive alongside the
binary.

## [0.0.3] - 2026-07-15

First tagged release. Everything before this version was unversioned development.
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
<LangVersion>latest</LangVersion>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<Deterministic>true</Deterministic>
<Version>0.0.3</Version>
<Version>0.0.4</Version>
</PropertyGroup>
</Project>
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,41 @@ with a `SHA256SUMS` file — unpack one binary and put it on `PATH`; there is no
installer to run. The release process is documented in
[docs/release-checklist.md](docs/release-checklist.md).

## Using the CLI

If you downloaded a release archive instead of building from source, unpack
`typeference` (`typeference.exe` on Windows) onto `PATH` and confirm it runs:

```sh
typeference version
```

`<source>` in every command below is a directory of your own typed agent
definitions (`schemaVersion: 3` YAML, shaped like the example above) — clone
this repository to point it at the bundled `examples/helio/` corpus instead.

```text
typeference validate <source> [--trust-config path]
typeference build <source> [--target all|neutral|codex|copilot|cursor] [--out dist]
[--emit-ard --publisher-domain example.com] [--trust-config path]
[--trust-signatures signatures.json] [--allow-unsigned-trust]
typeference inspect <agent-id> [--source path]
typeference diff <source> --against <compiled-dir> [--target all]
[--emit-ard --publisher-domain example.com] [--trust-config path]
[--trust-signatures signatures.json] [--json] [--allow-unsigned-trust]
typeference eval <source> --scenarios <file-or-dir> [--live] [--model id] [--out dir]
typeference equivalence pack <source> --scenarios <file-or-dir> --out <run-dir>
[--target all|<name>[,<name>...]]
typeference equivalence score <run-dir> [--live] [--model id]
```

`validate` checks composition and structural typing without writing anything.
`build` compiles to native target artifacts. `diff` recompiles and byte-compares
against an already-built directory — see [Quick start](#quick-start) above for
what "No differences." means. `eval` and `equivalence` are covered in
[Behavioral evals](#behavioral-evals) below; both default to a dry run that
never makes a network call.

## Two implementations, one specification

The C# implementation under `src/` is the reference implementation; the Go
Expand Down
Loading