Getting Started¶
Welcome to the Records Manager Skill. This section will guide you through installing, configuring, and using the skill for expert document management with paperless-ngx.
Overview¶
The Records Manager Skill is a PAI (Personal AI Infrastructure) pack that transforms your AI assistant into an expert records manager. It provides:
-
Intelligent document organization with automatic tagging and categorization
-
Country-specific compliance for record retention (Australia, US, UK)
-
Safe operations with mandatory deletion confirmation
-
Powerful search optimized for finding documents quickly
What You'll Need¶
Before you begin, ensure you have:
-
A PAI installation - The skill integrates with your PAI environment
-
A paperless-ngx instance - For document storage and management
-
Bun runtime - For running TypeScript tools
-
API credentials - paperless-ngx URL and API token
See Prerequisites for detailed requirements.
Installation Path¶
Follow these guides in order:
1. Prerequisites¶
Verify your system meets all requirements before installing.
2. Installation Guide¶
Step-by-step installation for PAI integration and paperless-ngx configuration.
3. Quickstart Tutorial¶
Upload your first document with intelligent tagging and learn the basics.
Quick Reference¶
After installation, you can use the Records Manager Skill:
# Upload a document
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts upload \
--file <path> --domain household
# Search for documents
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts search \
--query "insurance"
# Check retention status
bun run ~/.claude/skills/RecordsManager/Tools/RecordManager.ts retention \
--domain corporate
Next Steps¶
-
Configure your environment - Set up paperless-ngx connection
-
Upload your first document - Follow the quickstart tutorial
-
Explore taxonomies - Learn about entity types and tagging
-
Set up retention - Configure country-specific retention rules
Need Help?¶
-
Troubleshooting: See the Troubleshooting section
-
Configuration Guide: See Configuration
-
API Reference: See CLI Commands
What's Next?¶
After completing the getting started guide:
-
User Guide: Learn daily workflows for document management
-
Tutorials: Step-by-step guides for common tasks
-
Extending: Create custom taxonomies and entity types
-
Architecture: Understand system design and components