paperclip-plugin-file-manager
v1.0.0
Published
Track and manage files created by Paperclip agents
Maintainers
Readme
File Manager Plugin for Paperclip
Track, categorize, and manage files created by Paperclip agents.
Features
- 📁 Track files created by agents with metadata
- 🏷️ Categorize files (Documentation, Code, Assets, Reports, Logs)
- 🔍 Search files by category, agent, tags, date range
- 📊 Statistics view with file counts and sizes
- 🗂️ Auto-tagging by agent name
- ⏰ Retention policies for automatic cleanup
- 🎨 Dashboard UI with recent files widget
Installation
pnpm paperclipai plugin install @paperclip/plugin-file-manager
pnpm paperclipai plugin enable @paperclip/plugin-file-managerConfiguration
Configure the plugin in the Paperclip dashboard under Settings → Plugins → File Manager:
- Auto-tag files by agent: Automatically add agent name as a tag
- Default categories: Pre-defined file categories
- File retention (days): How long to keep file metadata (0 = forever)
Usage
Track a File
Agents can track files using the track-file tool:
await ctx.tools.invokeTool('track-file', {
path: '/path/to/file.txt',
filename: 'report.txt',
size: 1024,
category: 'Reports',
tags: ['quarterly', 'financial'],
agentId: 'agent-123',
agentName: 'Finance Reporter',
issueId: 'issue-456',
issueTitle: 'Q4 Financial Report',
output: 'Successfully generated Q4 2024 Financial Report'
});Search Files
const results = await ctx.tools.invokeTool('search-files', {
category: 'Reports',
tags: ['financial'],
dateFrom: '2024-01-01T00:00:00Z',
searchTerm: 'quarterly'
});Get File Details
const file = await ctx.tools.invokeTool('get-file-details', {
fileId: 'file-1234567890-abc123'
});Update File Metadata
await ctx.tools.invokeTool('update-file-metadata', {
fileId: 'file-1234567890-abc123',
category: 'Documentation',
tags: ['v1.0', 'api']
});Get Statistics
const stats = await ctx.tools.invokeTool('get-file-stats', {});
// Returns: { totalFiles, totalSize, byCategory, byAgent, recentFiles }Delete a File
await ctx.tools.invokeTool('delete-file', {
fileId: 'file-1234567890-abc123'
});Tools Reference
| Tool | Description |
|------|-------------|
| track-file | Register a new file for tracking |
| search-files | Search files by filters |
| get-file-details | Get detailed info about a file |
| update-file-metadata | Update category, tags, etc. |
| get-file-stats | Get file statistics |
| delete-file | Delete a tracked file |
Dashboard
The plugin provides two UI views:
- Dashboard Widget: Shows recent files and quick stats
- File Manager Page: Full file management interface at
/file-manager
Development
# Build the plugin
npm run build
# Watch for changes
npm run dev
# Run tests
npm test
# Type check
npm run typecheckLicense
MIT
Support
For issues and feature requests, visit the GitHub repository.
