{"_id":"@elizaos/plugin-clipboard","_rev":"2-c641122905e5515a011cda52509a6bf7","name":"@elizaos/plugin-clipboard","dist-tags":{"alpha":"2.0.0-alpha.7","latest":"2.0.0-alpha.7"},"versions":{"2.0.0-alpha.7":{"name":"@elizaos/plugin-clipboard","version":"2.0.0-alpha.7","keywords":["elizaos","plugin","clipboard","memory","notes","file-storage"],"author":{"name":"elizaOS Team"},"license":"MIT","_id":"@elizaos/plugin-clipboard@2.0.0-alpha.7","maintainers":[{"name":"haruhunab1320","email":"jakob@magickml.com"},{"name":"shawticus","email":"shawmakesmagic@gmail.com"},{"name":"odilitime","email":"janesmith@airmail.cc"}],"homepage":"https://github.com/elizaos-plugins/plugin-clipboard#readme","bugs":{"url":"https://github.com/elizaos-plugins/plugin-clipboard/issues"},"dist":{"shasum":"8cccaf3a9db8b36daf2cb421306ce44e45ad45c3","tarball":"https://registry.npmjs.org/@elizaos/plugin-clipboard/-/plugin-clipboard-2.0.0-alpha.7.tgz","fileCount":63,"integrity":"sha512-u2wnRrFioqZlfFg9tNYNYc1/c/ghNJS3aKQp35h3EflB9j/GKtIKN7u2z/JgGNHfdTUvp12bmt+YNy3GQY1Xhg==","signatures":[{"sig":"MEQCIGbprnxFsXRRwR5Qwact9QM94dE+OKSXjmtvXT4eHis5AiAujApq7tRL1xnvnhQKZ4uDUGIBe90cSGKVHb5Qn4y2vg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":923856},"main":"dist/node/index.node.js","type":"module","types":"dist/node/index.d.ts","milady":{"runtime":"both","platforms":["browser","node"],"platformDetails":{"node":"Node.js build available via exports.node","browser":"Browser-compatible build available via exports.browser"}},"module":"dist/node/index.node.js","exports":{".":{"node":{"types":"./dist/node/index.d.ts","import":"./dist/node/index.node.js","default":"./dist/node/index.node.js"},"types":"./dist/node/index.d.ts","browser":{"types":"./dist/browser/index.d.ts","import":"./dist/browser/index.browser.js","default":"./dist/browser/index.browser.js"},"default":"./dist/node/index.node.js"},"./package.json":"./package.json"},"gitHead":"0f94ac6fb9578630bc732dec9d6061c09f79c4f8","scripts":{"dev":"bun --hot build.ts","lint":"echo \"Lint skipped for release\"","test":"elizaos test || echo 'TypeScript tests skipped'","build":"bun run build.ts","clean":"rm -rf dist .turbo node_modules","format":"bunx @biomejs/biome format --write .","build:ts":"bun run build.ts","typecheck":"echo \"Typecheck skipped for release\"","lint:check":"bun run lint","format:check":"bunx @biomejs/biome format ."},"_npmUser":{"name":"shawticus","email":"shawmakesmagic@gmail.com"},"repository":{"url":"git+https://github.com/elizaos-plugins/plugin-clipboard.git","type":"git"},"_npmVersion":"11.7.0","agentConfig":{"pluginType":"elizaos:plugin:1.0.0","pluginParameters":{"CLIPBOARD_BASE_PATH":{"type":"string","required":false,"sensitive":false,"description":"Base directory for clipboard files (default: ~/.eliza/clipboard)"},"CLIPBOARD_MAX_FILE_SIZE":{"type":"number","default":1048576,"required":false,"sensitive":false,"description":"Maximum file size in bytes (default: 1MB)"}}},"description":"File-based memory storage plugin for ElizaOS - persistent notes and memories","directories":{},"sideEffects":false,"_nodeVersion":"22.20.0","dependencies":{"@elizaos/core":"alpha"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"^1.3.9","typescript":"^5.9.3","@types/node":"^25.0.3","@biomejs/biome":"^2.3.11"},"peerDependencies":{"@elizaos/core":"alpha"},"_npmOperationalInternal":{"tmp":"tmp/plugin-clipboard_2.0.0-alpha.7_1776036693661_0.2375445791056081","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-04-12T23:31:33.534Z","modified":"2026-06-16T05:14:04.554Z","2.0.0-alpha.7":"2026-04-12T23:31:33.836Z"},"bugs":{"url":"https://github.com/elizaos-plugins/plugin-clipboard/issues"},"author":{"name":"elizaOS Team"},"license":"MIT","homepage":"https://github.com/elizaos-plugins/plugin-clipboard#readme","keywords":["elizaos","plugin","clipboard","memory","notes","file-storage"],"repository":{"url":"git+https://github.com/elizaos-plugins/plugin-clipboard.git","type":"git"},"description":"File-based memory storage plugin for ElizaOS - persistent notes and memories","maintainers":[{"email":"shawmakesmagic@gmail.com","name":"shawticus"},{"email":"janesmith@airmail.cc","name":"odilitime"}],"readme":"# @elizaos/plugin-clipboard\n\nFile-based memory storage plugin for ElizaOS. Provides persistent notes and memories that can be written, read, searched, and managed across sessions.\n\n## Overview\n\nThis plugin enables agents to maintain a persistent clipboard of notes and memories stored as markdown files. It's inspired by the Otto memory-core extension and provides similar functionality adapted for the ElizaOS plugin architecture.\n\n## Features\n\n- **Persistent Storage**: Notes are stored as markdown files that persist across sessions\n- **Semantic Search**: Search through entries by content with relevance scoring\n- **CRUD Operations**: Full support for Create, Read, Update (append), and Delete\n- **Tagging**: Organize entries with tags for better categorization\n- **Provider Integration**: Automatic context about clipboard state for the agent\n\n## Installation\n\n```bash\nnpm install @elizaos/plugin-clipboard\n```\n\n## Usage\n\nAdd the plugin to your agent configuration:\n\n```typescript\nimport { clipboardPlugin } from \"@elizaos/plugin-clipboard\";\n\nconst agent = {\n  // ... other config\n  plugins: [clipboardPlugin],\n};\n```\n\n## Actions\n\n### CLIPBOARD_WRITE\n\nCreate a new clipboard entry.\n\n**Similes**: SAVE_NOTE, CREATE_NOTE, WRITE_NOTE, REMEMBER_THIS, SAVE_MEMORY, JOT_DOWN, NOTE_THIS\n\n**Example**:\n```\nUser: \"Please save a note about the meeting tomorrow at 3pm with John\"\nAgent: \"I've saved a note titled 'Meeting with John'. You can retrieve it later.\"\n```\n\n### CLIPBOARD_READ\n\nRead the content of a specific clipboard entry.\n\n**Similes**: GET_NOTE, READ_NOTE, RETRIEVE_NOTE, GET_MEMORY, FETCH_NOTE, OPEN_NOTE\n\n**Example**:\n```\nUser: \"Show me the note about the meeting\"\nAgent: \"Here's the note 'Meeting with John': Meeting scheduled for tomorrow at 3pm...\"\n```\n\n### CLIPBOARD_SEARCH\n\nSearch through clipboard entries for relevant information.\n\n**Similes**: FIND_NOTE, SEARCH_NOTES, LOOKUP_MEMORY, FIND_MEMORY, SEARCH_MEMORY, RECALL\n\n**Example**:\n```\nUser: \"What notes do I have about marketing?\"\nAgent: \"I found 2 entries mentioning marketing: 1) 'Marketing Strategy' (85% match)...\"\n```\n\n### CLIPBOARD_LIST\n\nList all clipboard entries with their titles and modification dates.\n\n**Similes**: SHOW_NOTES, LIST_NOTES, ALL_NOTES, MY_NOTES, SHOW_MEMORIES\n\n**Example**:\n```\nUser: \"Show me all my saved notes\"\nAgent: \"You have 5 clipboard entries: 1) Meeting notes (modified today)...\"\n```\n\n### CLIPBOARD_APPEND\n\nAppend additional content to an existing clipboard entry.\n\n**Similes**: ADD_TO_NOTE, UPDATE_NOTE, APPEND_NOTE, EXTEND_NOTE, ADD_MORE\n\n**Example**:\n```\nUser: \"Add to the meeting notes that we decided on a $50k budget\"\nAgent: \"I've appended the budget decision to the meeting notes.\"\n```\n\n### CLIPBOARD_DELETE\n\nDelete a clipboard entry by its ID.\n\n**Similes**: REMOVE_NOTE, DELETE_NOTE, FORGET_NOTE, ERASE_NOTE, REMOVE_MEMORY\n\n**Example**:\n```\nUser: \"Delete the note about the old meeting\"\nAgent: \"I've deleted the clipboard entry 'old-meeting'.\"\n```\n\n## Provider\n\n### clipboard\n\nProvides information about the user's clipboard entries to the agent's context. This allows the agent to be aware of saved notes without explicitly querying.\n\nThe provider returns:\n- Summary of recent entries (up to 5)\n- Total count of entries\n- Entry IDs and titles\n\n## Configuration\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| CLIPBOARD_BASE_PATH | string | ~/.eliza/clipboard | Base directory for clipboard files |\n| CLIPBOARD_MAX_FILE_SIZE | number | 1048576 | Maximum file size in bytes (1MB) |\n\n## File Format\n\nEntries are stored as markdown files with YAML frontmatter:\n\n```markdown\n---\ntitle: \"Meeting with John\"\ncreated: 2024-01-15T10:30:00.000Z\nmodified: 2024-01-15T10:30:00.000Z\ntags: [meeting, marketing]\n---\n\nMeeting scheduled for tomorrow at 3pm to discuss marketing strategy.\n```\n\n## Development\n\n```bash\n# Build\nbun run build\n\n# Type check\nbun run typecheck\n\n# Lint\nbun run lint\n\n# Test\nbun run test\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}