') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); chore: add memory documentation hints to CLI output by aidandaly24 · Pull Request #227 · aws/agentcore-cli · GitHub
Skip to content

chore: add memory documentation hints to CLI output - #227

Merged
tejaskash merged 1 commit into
mainfrom
feature/memory-docs-hints
Feb 10, 2026
Merged

chore: add memory documentation hints to CLI output#227
tejaskash merged 1 commit into
mainfrom
feature/memory-docs-hints

Conversation

@aidandaly24

@aidandaly24aidandaly24 commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Description

Improves discoverability of memory configuration documentation by adding contextual hints in CLI output.

Changes:

  • Added "Swapping or Changing Memory (Strands)" section to docs/memory.md explaining how to change which memory an agent uses
  • Added "Adding Memory to an Agent Without Memory (Strands)" section with step-by-step instructions
  • After agentcore add agent: Shows a note with clickable link to relevant docs section based on whether memory was selected
  • After agentcore add memory: Shows a note explaining memory isn't auto-connected, with link to docs

Links use ink-link (existing pattern from LogLink.tsx) for clickable hyperlinks in supported terminals, with anchor fragments to navigate directly to the relevant section.

Related Issues

N/A

Documentation PR

Documentation is included in this PR (docs/memory.md)

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Testing

How have you tested the change?

  • I ran npm run test:all
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Manually tested by running npm pack && npm install -g and verifying the notes appear after agentcore add agent and agentcore add memory.

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.

@aidandaly24
Add memory documentation hints to CLI output
5b97471
- Add 'Swapping or Changing Memory (Strands)' section to docs/memory.md
- Add 'Adding Memory to an Agent Without Memory (Strands)' section to docs/memory.md
- Show clickable docs/memory.md link after 'agentcore add agent'
- Show clickable docs/memory.md link after 'agentcore add memory'
- Links use anchors to navigate directly to relevant section
@aidandaly24
aidandaly24 requested a review from a teamFebruary 10, 2026 02:46
@github-actions

github-actionsBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

StatusCategoryPercentageCovered / Total
🔵Lines7.59%495 / 6521
🔵Statements7.29%506 / 6938
🔵Functions4.77%64 / 1341
🔵Branches5.6%211 / 3764
Generated in workflow #221 for commit 5b97471 by the Vitest Coverage Report Action

@tejaskash
tejaskash merged commit 97227c6 into mainFeb 10, 2026
14 checks passed
@tejaskash
tejaskash deleted the feature/memory-docs-hints branch February 10, 2026 02:50
@agentcore-cli-automation

agentcore-cli-automation commented Jun 9, 2026

Copy link
Copy Markdown

Reviewing this PR (already merged) — flagging a few issues for awareness / potential follow-up:

1. Wrong docs anchor in AddMemoryFlow.tsx (real bug)

In src/cli/tui/screens/memory/AddMemoryFlow.tsx (around line 67 in the diff), the link reads:

Note: See docs/memory.md to learn how to connect memory to your agent.

But the anchor #swapping-or-changing-memory-strands points to the section about swapping an existing connected memory. A user who just ran agentcore add memory typically does not have memory connected to an agent yet — the wording promises "connect memory to your agent" but the link sends them to a swap workflow. The appropriate target is the new section #adding-memory-to-an-agent-without-memory-strands.

Options:

  • Point at the "Adding Memory to an Agent Without Memory" anchor instead.
  • Or drop the anchor and link to the top of docs/memory.md, since the user might need either flow.

2. Brittle hardcoded heading anchors

The CLI hardcodes specific anchor fragments (#swapping-or-changing-memory-strands, #adding-memory-to-an-agent-without-memory-strands) into three call sites. There is nothing tying these strings to the headings in docs/memory.md, so any rename of those headings silently breaks the links shipped in the CLI binary.

(Indeed, this has effectively already happened on main in #232 — the headings were renamed to ### Switching Memory and ### Adding Memory to an Agent Without Memory, so the anchors in the source code now 404 against the live doc. That is post-merge fallout, but worth fixing now.)

Options:

  • Link to the top of docs/memory.md and let the page TOC do the navigation.
  • Add a small test that asserts each anchor used in source exists as a heading in docs/memory.md (slugify and check), so renames break CI instead of breaking silently in users' terminals.
  • Centralize the URLs in a single MEMORY_DOCS_URL constant instead of duplicating the base URL across 3 sites.

3. Duplicated logic in AddFlow.tsx

The memoryDocAnchor / memoryNotePrefix block, and the <Box marginTop={1}><Text color="yellow">...</Text></Box> JSX, are duplicated verbatim between the agent-create-success and agent-byo-success branches (lines 290–312 vs 331–353). Worth extracting into a small MemoryDocsHint component (or even a single helper) so the two flows can't drift.

4. No tests for the new conditional branching

The PR's own checklist notes "I have added any necessary tests" is unchecked. The new branching on flow.config.memory !== 'none' produces user-facing strings/links and would be cheap to cover with a snapshot or rendered-output test in AddFlow.tsx / AddMemoryFlow.tsx. Particularly relevant given issue #1 above, which a snapshot test would have surfaced.

(Skipping telemetry — this is a static UI hint with no user action to instrument.)

@github-actions

github-actionsBot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Thanks for the report, @agentcore-cli-automation — feedback like this is exactly
how we catch the things we missed. Because this PR is already
closed, the team won't see follow-up comments here.

Would you mind opening a new issue so we can track it properly?
https://github.com/aws/agentcore-cli/issues/new/choose

If this is a security issue, please report it privately via
https://aws.amazon.com/security/vulnerability-reporting/ instead
of a public issue.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tejaskashtejaskashtejaskash approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aidandaly24@agentcore-cli-automation@tejaskash