Skip to content

Document how Attest resolves <attest_home> for receipt paths #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sykosyber merged 2 commits into from
Oct 26, 2026
Merged

Document how Attest resolves <attest_home> for receipt paths #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5bec40
Document how Attest resolves <attest_home> for receipt paths
cursoragent Oct 25, 2026
437a759
Rewrap the receipt CLI docstring after the <attest_home> note
sykosyber Oct 25, 2026
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
14 changes: 10 additions & 4 deletions examples/attest_receipt_observe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
"""Print an unverified SyberWork observation from an Attest v0 receipt file.

Attest writes these receipts under `<attest_home>/receipts/<case_id>.json`.
This example only translates the JSON into Work.observe-compatible arguments;
it does not append to a case or verify receipt authority.
Attest writes these receipts under `<attest_home>/receipts/<case_id>.json`,
where `<attest_home>` is Attest's `--home`, else `$ATTEST_HOME`, else `.attest`
relative to Attest's working directory. `.attest/receipts` is only that default;
pass the receipt path explicitly rather than assuming it. This example only
translates the JSON into Work.observe-compatible arguments; it does not append
to a case or verify receipt authority.
"""

from __future__ import annotations
Expand Down Expand Up @@ -102,7 +105,10 @@ def main(argv: list[str] | None = None) -> int:
parser.add_argument(
"receipt",
type=Path,
help="receipt path (Attest writes <attest_home>/receipts/<case_id>.json)",
help=(
"receipt path (Attest writes <attest_home>/receipts/<case_id>.json; "
"<attest_home> is Attest's --home, else $ATTEST_HOME, else .attest)"
),
)
args = parser.parse_args(argv)
try:
Expand Down
Loading