feat(export): surface export notes inline in the CLI and TUI#1676
Merged
Conversation
Export notes (manual follow-up items like "browser tool needs a Container build"
or "verify the path skill exists in the image") were only written to
app/<agent>/EXPORT_NOTES.md and referenced by a single passive line, so they were
easy to miss.
Return the notes from handleExportHarness and render them prominently on success:
- CLI: a yellow "N export note(s) requiring manual follow-up" block listing each
note's category + message, with a pointer to EXPORT_NOTES.md; a "no manual
follow-up required" line when there are none.
- TUI: the same notes shown on the export success screen above the next-steps menu.
- --json: notes are included as a structured `notes[]` array (each {category,
message}) via serializeResult, so scripts/CI can consume them.
EXPORT_NOTES.md is still written unchanged. Verified live on both surfaces (a
browser-on-CodeZip export shows the note; a plain harness shows none) and via --json.
Contributor
Package TarballHow to installgh release download pr-1676-tarball --repo aws/agentcore-cli --pattern "*.tgz" --dir /tmp/pr-tarball
npm install -g /tmp/pr-tarball/aws-agentcore-0.21.1.tgz |
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
agentcore-cli-automation
approved these changes
Jun 30, 2026
agentcore-cli-automation
left a comment
There was a problem hiding this comment.
LGTM — small, focused change. Plumbing already-collected exportNotes through handleExportHarness's success result and rendering them on the three surfaces (CLI block, TUI success screen, --json via serializeResult) is a clear win in discoverability over the old single-line pointer.
A few observations, none blocking:
- Telemetry already covers this via the existing
notes_countattribute onexport.harness— no instrumentation gap. - No new mocking introduced; the existing
harness-action.test.tscontinues to cover the note-builder functions. - The new
notes: ExportNote[]field on the--jsonsuccess payload becomes an implicit public contract for scripted consumers. Worth keepingExportNote's shape ({ category, message }) stable going forward, or adding a brief schema note somewhere if--jsonoutputs are documented elsewhere. - The CLI/TUI rendering of the notes themselves isn't covered by a test (just manual verification per the PR description). The formatting is simple and the underlying builders are tested, so I don't think it's necessary to block on this, but a small assertion that
result.notesflows through to stdout (or a TUI snapshot) would harden the contract if you want to add it.
Contributor
Coverage Report
|
Addresses the PR review note that the CLI/TUI note rendering had no unit coverage (only manual verification). Extract the note-formatting into a pure `formatExportNotes(notes, notesFileHint)` helper that returns tone-tagged lines (`warn`/`dim`), and have both the CLI (tone → ANSI) and the TUI export success screen (tone → Ink color) render from it. This makes the output testable without spawning the command and keeps the two surfaces' wording in sync (also removes the earlier duplicated rendering logic). Add format-export-notes.test.ts covering the no-notes line, singular/plural header, category + multi-line message expansion, and the EXPORT_NOTES.md hint.
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
The CLI `--json` branch emits `JSON.stringify(serializeResult(result))`, so the
export success result's `notes` array is a public contract for scripted
consumers. Add cases asserting serializeResult preserves the notes array, that
it survives a JSON round-trip as structured { category, message } objects, and
that an empty notes list serializes to `[]` (not undefined).
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
avi-alpert
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Export notes — manual follow-up items the exporter emits (e.g. "browser tool requires a Container build", "verify the path skill exists in the image", "malformed S3 skill URI") — were only written to
app/<agent>/EXPORT_NOTES.mdand surfaced by a single passive line in the CLI output. They were easy to miss, which defeats their purpose.This makes them prominent on the export success path, on both surfaces:
⚠ N export note(s) requiring manual follow-up:block listing each note's category + (multi-line) message, with a pointer toEXPORT_NOTES.md. When there are none:No manual follow-up required.--json: the notes are returned as a structurednotes[]array (each{ category, message }) viaserializeResult, so scripts/CI can consume them programmatically.handleExportHarnessnow returnsnotes: ExportNote[]in its success result (single source for all three surfaces).EXPORT_NOTES.mdis still written unchanged.Related Issue
Type of Change
Testing
npm run typecheck(clean)npm run lint(clean)npm run test:unit— export unit suites pass (150)--jsonincludes thenotes[]array.Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.