aoe-tool
v1.0.3
Published
Advanced Office Extractor - Backend Tool
Maintainers
Readme
AOE Tool - Advanced Operations Environment
A comprehensive local development server that provides secure communication channels for advanced office operations and data processing tasks.
What It Does
AOE Tool creates a secure local environment for processing and managing office documents and data. It establishes encrypted communication channels that allow applications to safely handle sensitive information while maintaining complete data privacy on your local machine.
Key Capabilities
- 🔐 Secure Local Server: Creates encrypted HTTPS connections for safe data handling
- 📡 Real-time Communication: Enables instant bidirectional data exchange between applications
- 🛡️ Data Privacy: All processing happens locally - no data leaves your machine
- 🌐 Local Domain Management: Automatically configures local domains for seamless operation
- 📋 Office Data Processing: Specialized handling of office documents and structured data
- 🔑 SSL Certificate Management: Automated security certificate installation and management
Installation
Quick Install
# Install globally
npm install -g aoe-toolFrom Source
# Clone and build
git clone <repository-url>
cd aoe-tool
npm install
npm run build
npm install -g .Getting Started
1. Start the Server
# Basic server (HTTP only)
aoe start
# Secure server with SSL (recommended)
aoe start --sslNote: SSL mode requires administrator privileges for security certificate installation.
2. SSL Certificate Management
# Check SSL status
aoe ssl
# Install SSL certificates (requires admin privileges)
aoe ssl --install
# Install for custom domain
aoe ssl --install --domain myapp.local
# Remove SSL certificates
aoe ssl --uninstallCommands Reference
| Command | Description | Admin Required |
|---------|-------------|----------------|
| aoe start | Start basic HTTP server | No |
| aoe start --ssl | Start secure HTTPS server | Yes |
| aoe ssl | Check SSL certificate status | No |
| aoe ssl --install | Install SSL certificates | Yes |
| aoe ssl --uninstall | Remove SSL certificates | Yes |
| aoe --help | Show detailed help | No |
| aoe --version | Show version information | No |
Security & Privacy
Local-Only Operation
- No External Connections: All operations are confined to your local machine
- No Data Transmission: Your data never leaves your computer
- Localhost Binding: Server only accepts connections from 127.0.0.1
Encryption & Certificates
- End-to-End Encryption: All communications are encrypted using SSL/TLS
- Self-Signed Certificates: Certificates are generated locally and trusted only on your machine
- Automatic Certificate Management: Handles certificate generation, installation, and renewal
Administrative Privileges
Some operations require administrator privileges to:
- Install SSL certificates in system trust store
- Modify hosts file for local domain resolution
- Configure system security policies
The application will automatically prompt for elevated privileges when needed and explain why they are required.
Configuration
AOE Tool stores its configuration in your home directory:
~/.aoe-tool/
├── ssl/ # SSL certificates and keys
├── .email.yqb # Email processing data
└── .item.yqb # Item processing dataTroubleshooting
SSL Certificate Issues
# Remove and regenerate certificates
aoe ssl --uninstall
aoe ssl --installPermission Issues
# Run with administrator privileges
sudo aoe ssl --install # macOS/Linux
# Or "Run as administrator" on WindowsServer Won't Start
# Check if another service is using the port
# Try starting without SSL first
aoe startFrequently Asked Questions
Why does AOE Tool need administrator privileges?
Administrator privileges are required only for SSL certificate operations to:
- Install trusted certificates in your system's security store
- Modify the hosts file for local domain resolution
- Ensure secure, encrypted connections
Is my data safe?
Yes, absolutely. AOE Tool:
- Runs exclusively on your local machine (localhost only)
- Never transmits data to external servers
- Uses industry-standard encryption for all communications
- Stores all data locally in your home directory
Can I use AOE Tool without SSL?
Yes, you can run aoe start without the --ssl flag for basic HTTP operation. However, SSL is strongly recommended for:
- Enhanced security and data protection
- Compatibility with modern web browsers
- Secure WebSocket connections
What domains does AOE Tool use?
By default, AOE Tool uses aoe-tool.test as the local domain. You can specify custom domains using the --domain option with SSL commands.
How do I uninstall AOE Tool?
# Remove SSL certificates first
aoe ssl --uninstall
# Uninstall the application
npm uninstall -g aoe-tool
# Optionally remove configuration directory
rm -rf ~/.aoe-toolSupport & Documentation
For additional help and documentation:
- Run
aoe --helpfor detailed command information - Check the troubleshooting section above for common issues
- Review the configuration directory at
~/.aoe-tool/for stored data
License
MIT License - see LICENSE file for details.
