메뉴
How to create, read, update, and delete documents. Covers the document scripts, markdown content model, parent-child hierarchy, and position ordering.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | document-editing |
| description | How to create, read, update, and delete documents. Covers the document scripts, markdown content model, parent-child hierarchy, and position ordering. |
Documents are stored in the SQL database via Drizzle ORM. Each document has a title, stable description, markdown content, optional parent (for nesting), and a position for ordering. The description explains why the page exists and what belongs there; it is not a changing synopsis of the current body.
Always use the dedicated scripts for document operations. Never use raw db-exec SQL.
List document metadata in a tree structure. This intentionally does not return full document bodies; call get-document for the one document you need to read.
pnpm action list-documents
pnpm action list-documents --format json
Search documents by title and content. Results include snippets, not full document bodies; call get-document before editing or summarizing a specific result.
pnpm action search-documents --query "meeting notes"
pnpm action search-documents --query "project plan" --format json
Get a single document by ID with full content.
pnpm action get-document --id abc123
pnpm action get-document --id abc123 --format json
Create a new document.
pnpm action create-document --title "Meeting Notes" --content "# Meeting Notes\n\nAttendees: ..."
pnpm action create-document --title "Sub Page" --parentId parent123
pnpm action create-document --title "My Page" --icon "📝"
pnpm action create-document --title "Research" --description "Evidence and source notes that support the current project"
Surgically edit document content using search-and-replace. Preferred over update-document --content for modifications — sends only the changed text instead of regenerating the entire document.
# Single edit
pnpm action edit-document --id abc123 --find "old text" --replace "new text"
# Delete text
pnpm action edit-document --id abc123 --find "delete me" --replace ""
# Batch edits
pnpm action edit-document --id abc123 --edits '[{"find":"old","replace":"new"},{"find":"also old","replace":"also new"}]'
Update an existing document. Use for full rewrites or new content, not for small changes (use edit-document instead).
pnpm action update-document --id abc123 --title "New Title"
pnpm action update-document --id abc123 --content "# Updated Content\n\nNew text here"
pnpm action update-document --id abc123 --title "New Title" --content "New content"
pnpm action update-document --id abc123 --description "Stable guidance for what belongs on this page"
Move a document and all its children to Trash. IDs, bodies, hierarchy, and database membership remain intact so the subtree can be restored.
pnpm action delete-document --id abc123
Restore the root subtree, or permanently delete it only after it is in Trash:
pnpm action restore-document --id abc123
pnpm action permanently-delete-document --id abc123
Comments are Notion/Google-Docs-style inline comments. Selecting text and commenting leaves the passage highlighted inline via a ProseMirror decoration overlay — nothing is written into the markdown body, so the document round-trips unchanged. Each thread stores the quoted text plus surrounding context (anchorPrefix/anchorSuffix) and an approximate anchorStartOffset, so the highlight follows the text as the document is edited, disambiguates repeated text, and degrades gracefully (the thread stays in the sidebar) when its text is deleted.
Resolving a thread clears its highlight and moves it to a collapsible "Resolved (n)" sidebar section, from which it can be reopened. Comments support @mentions of org members, stored as a mentions array of {email, name}.
# List threads (returns anchor fields + parsed mentions)
pnpm action list-comments --documentId abc123
# Plain comment on the document
pnpm action add-comment --documentId abc123 --content "Looks good"
# Inline-anchored comment with a mention
pnpm action add-comment --documentId abc123 --content "@Sam check this" \
--quotedText "the second paragraph" --anchorPrefix "above " --anchorSuffix " here" \
--anchorStartOffset 120 --mentions '[{"email":"sam@x.com","name":"Sam"}]'
# Reply to a thread
pnpm action add-comment --documentId abc123 --threadId t123 --content "Agreed"
# Resolve / reopen the whole thread
pnpm action update-comment --id c123 --resolved true
pnpm action update-comment --id c123 --resolved false
--authorName sets the comment's display name; it defaults to a name derived from the author's email.
Trigger the UI to refresh the document list.
pnpm action refresh-list
Always run this after any document modification to update the sidebar.
| Column | Type | Description |
|---|---|---|
id | text | Primary key (12-char hex string) |
parent_id | text | Parent document ID (null for root) |
title | text | Document title (default: "Untitled") |
description | text | Stable semantic guidance for the page |
content | text | Markdown content |
icon | text | Emoji icon (optional) |
position | integer | Sort order within parent (0-based) |
is_favorite | integer | Whether document is favorited (0 or 1) |
created_at | text | ISO timestamp |
updated_at | text | ISO timestamp |
Documents use markdown for content. The editor renders markdown in real time.
Content renders LaTeX with KaTeX while preserving the source in NFM. Use the canonical Content delimiters when an agent creates or edits math:
Inline math: The relationship is $`E = mc^2`$ in this example.
Block math:
$$
\int_0^1 x^2 dx = \frac{1}{3}
$$
$`...`$. Do not substitute ordinary $...$; dollar
amounts in prose are intentionally not interpreted as equations.$$ on their own lines before and after the LaTeX.Documents form a tree via parent_id:
parent_id = nullidDescriptions are owned; context is inherited. get-document and view-screen
return the focused page's own description plus a computed root-to-parent
contextPath. Use that path to understand where the page lives, but never copy
ancestor descriptions into the child. Database, property, and option
descriptions narrow the guidance further when working with structured values.
| User says | What to do |
|---|---|
| "Create a page about X" | create-document --title "X" --content "# X\n\n..." |
| "Describe what belongs here" | update-document --id ... --description "..." |
| "Find my meeting notes" | search-documents --query "meeting notes" |
| "Fix a typo / edit a line" | view-screen to get ID, then edit-document --id ... --find "old" --replace "new" |
| "Rewrite this document" | view-screen to get ID, then update-document --id ... --content ... |
| "Delete this page" | view-screen to get ID, then delete-document --id ... |
| "Add a sub-page" | create-document --title "Sub" --parentId <parentId> |
| "Show me the document tree" | list-documents |
Always run refresh-list after any create, update, or delete operation.
How to look up version-matched Agent Native framework docs and source in node_modules. Use before coding against @agent-native/core APIs or advanced features.
Creating, editing, and managing extensions — sandboxed Alpine.js mini-apps that run inside iframes. Use when a user asks for a dashboard, widget, calculator, or any interactive mini-app that calls external APIs. Distinct from LLM "tools" (function calls) — see note below.
Agent observability, evals, feedback, and experiments. Use when adding observability dashboards, configuring trace capture, setting up evals, creating A/B experiments, or collecting user feedback on agent responses.
Server-side analytics tracking with pluggable providers. Use when adding analytics events, registering custom tracking providers, or configuring built-in providers (PostHog, Mixpanel, Amplitude, Webhook).
Live calendar-backed meetings in Clips — upcoming Google Calendar events, desktop join/record reminders, live transcripts with mic + system-audio capture, AI summary / bullets / per-attendee action items, and the bidirectional recording↔meeting link. Use when listing meetings, opening a meeting detail, finalizing notes, connecting a calendar, or working with attendee-tagged transcript segments.
Declare, evaluate, manage, and remove framework feature flags. Use when shipping a capability gradually, targeting users or organizations, or replacing a compile-time rollout switch with a production-safe runtime flag.