vldb-toolkits
v0.2.0
Published
Paper Management Platform for VLDB - Node.js CLI wrapper for desktop application
Maintainers
Readme
VLDB-Toolkits
Paper Management Platform for VLDB - Node.js CLI wrapper
VLDB-Toolkits is a desktop application for managing academic papers and author information. This Node.js package provides a convenient command-line interface to download and launch the application.
Features
- 📚 Import and manage academic papers from Excel
- 👥 Track author profiles and affiliations
- 📊 Visualize paper metadata and statistics
- 📤 Export organized datasets with custom formatting
- 🖥️ Cross-platform desktop application (macOS, Windows, Linux)
- 🚀 Simple one-command installation via npm
Installation
Global Installation (Recommended)
npm install -g vldb-toolkitsLocal Installation
npm install vldb-toolkits
npx vldb-toolkitsPlatform Support
- macOS: Apple Silicon (ARM64) and Intel (x86_64)
- Windows: x64
- Linux: x64
Usage
Launch the Application
Simply run:
vldb-toolkitsOn first run, the application binary will be automatically downloaded (~50-150 MB depending on platform). The binary is stored in ~/.vldb-toolkits/ for future use.
Command-Line Options
# Show help
vldb-toolkits --help
# Show version
vldb-toolkits --version
# Force reinstall the binary
vldb-toolkits --install
# Show binary installation path
vldb-toolkits --pathUse in npm Scripts
Add to your package.json:
{
"scripts": {
"vldb": "vldb-toolkits"
}
}Then run:
npm run vldbHow It Works
This Node.js package is a lightweight wrapper (~20 KB + dependencies) that:
- Detects your operating system and architecture
- Downloads the appropriate pre-built binary from GitHub Releases (only on first run)
- Launches the desktop application
The actual application is built with:
- Frontend: React + TypeScript
- Backend: Tauri (Rust)
- UI: Ant Design + Fluent UI
Development
Project Structure
VLDB-Toolkits/
├── app/ # Tauri desktop application
│ ├── src/ # React frontend
│ └── src-tauri/ # Rust backend
└── node-wrapper/ # Node.js CLI wrapper
├── lib/
│ ├── cli.js # CLI entry point
│ ├── config.js # Configuration
│ └── downloader.js # Binary downloader
├── test/
└── package.jsonBuilding from Source
To build the desktop application from source:
cd app
npm install
npm run tauri:buildTesting Locally
cd node-wrapper
# Install dependencies
npm install
# Run tests
npm test
# Test CLI locally
node lib/cli.js --versionPublishing to npm
cd node-wrapper
# Login to npm
npm login
# Publish
npm publishRequirements
- Node.js 14.0.0 or higher
- Internet connection (for initial binary download)
Configuration
The package stores data in:
- Binary:
~/.vldb-toolkits/bin/ - Version:
~/.vldb-toolkits/version.txt
Troubleshooting
Download Issues
If download fails, try:
vldb-toolkits --installPermission Issues (Linux/macOS)
If the binary is not executable:
chmod +x ~/.vldb-toolkits/bin/vldb-toolkitsNode.js Version
Ensure you're using Node.js 14 or higher:
node --versionManual Installation
You can also download binaries directly from GitHub Releases.
API
Programmatic Usage
You can also use the package programmatically:
const { checkAndInstall, getBinaryPath } = require('vldb-toolkits/lib/downloader');
// Check and install binary
await checkAndInstall();
// Get binary path
const binaryPath = getBinaryPath();
console.log(`Binary location: ${binaryPath}`);License
MIT License - see LICENSE file for details
Author
Silan Hu
- Email: [email protected]
- GitHub: @Qingbolan
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Acknowledgments
Built with:
- Tauri - Desktop application framework
- React - UI library
- Ant Design - UI components
- Fluent UI - Microsoft design system
- Node.js - JavaScript runtime
Related Packages
- Python:
pip install vldb-toolkits- Python wrapper for the same application
