Skip to content

docs: add local agent smoke runbook#291

Open
UncleJ-h wants to merge 2 commits into
EverMind-AI:mainfrom
UncleJ-h:docs/local-agent-smoke-runbook
Open

docs: add local agent smoke runbook#291
UncleJ-h wants to merge 2 commits into
EverMind-AI:mainfrom
UncleJ-h:docs/local-agent-smoke-runbook

Conversation

@UncleJ-h

Copy link
Copy Markdown

Summary

  • Add a local agent smoke runbook for agent builders integrating EverOS with multiple local runtimes.
  • Cover loopback proxy bypass, write + flush, cascade sync for read-your-write, cross-runtime read, source markdown deletion, and /get + /search absence checks.
  • Link the new guide from the documentation index.

Why

Agent runtimes often run in shells with proxy variables, separate process state, and automatic hook ambitions. This runbook gives builders a small manual proof before they wire EverOS into production agent hooks.

Validation

  • git diff --check
  • Verified linked doc targets exist locally
  • Cross-checked the runbook claims against existing api.md, how-memory-works.md, storage_layout.md, cli.md, and SECURITY.md

Scope

Docs only. No runtime behavior changes.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 16, 2026 14:54

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a local agent “smoke test” runbook to validate multi-runtime safety and indexing behavior when using a local EverOS service, and links it from the docs index.

Changes:

  • Added a step-by-step smoke runbook for writing, syncing, reading, deleting, and verifying memory absence across runtimes.
  • Documented proxy-bypass setup for loopback requests.
  • Linked the new runbook from docs/index.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/local-agent-smoke.md New runbook documenting an end-to-end local smoke test across two runtimes, including deletion/absence verification.
docs/index.md Adds the new runbook to the operations docs table for discoverability.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/local-agent-smoke.md Outdated
```bash
EPISODE_DIR="$EVEROS_MEMORY__ROOT/$APP_ID/$PROJECT_ID/users/$USER_ID/episodes"
find "$EPISODE_DIR" -type f -name 'episode-*.md' -print
rm "$EPISODE_DIR"/episode-*.md
Comment thread docs/local-agent-smoke.md Outdated
Terminal A:

```bash
export EVEROS_MEMORY__ROOT="$(mktemp -d /tmp/everos-agent-smoke-XXXXXX)"
@UncleJ-h

Copy link
Copy Markdown
Author

Addressed Copilot review feedback in 01f6f77.\n\n- Replaced the mktemp-based smoke root command with python3 tempfile.mkdtemp() to avoid GNU/BSD mktemp differences.\n- Replaced the rm glob deletion with find ... -print -delete, and added a note to stop if no episode file is printed.\n- Verified git diff --check, tempfile creation, empty-match delete behavior, and existing episode deletion locally.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants