Installation
Get MediaProc up and running in minutes.
Prerequisites
System Requirements
Before installing MediaProc, ensure your system meets these requirements:
- Node.js: Version 22.0.0 or higher
- Package Manager: npm, pnpm, yarn, or bun
- Disk Space: At least 500MB for CLI and plugins
Install MediaProc CLI
To install the MediaProc CLI:
Terminal
$ npm install -g @mediaproc/cli
Verify Installation
Check that MediaProc is installed correctly:
Terminal
$ mediaproc --version
@mediaproc/cli v1.0.0
Install Plugins
MediaProc uses a plugin architecture. Install plugins as needed:
Install Image Plugin
Terminal
$ mediaproc add image
✓ Installing @mediaproc/image plugin...
✓ Plugin installed successfully
Install Multiple Plugins (Coming Soon...)
Terminal
$ mediaproc add video audio document
✓ Installing 3 plugins...
✓ All plugins installed
Install All Official Plugins
$ mediaproc add image video audio document animation 3d stream ai metadata pipeline
Update MediaProc
Keep your installation up to date:
$ npm update -g @mediaproc/cli
Terminal
$ mediaproc update image
✓ Updated @mediaproc/image to v1.2.0
Terminal
$ mediaproc update
✓ Updated 5 plugins
Uninstall
To remove MediaProc:
$ npm uninstall -g @mediaproc/cli
Terminal
$ mediaproc delete image
✓ Removed @mediaproc/image
$ npm uninstall -g @mediaproc/image
Troubleshooting
Permission Errors
If you encounter permission errors, use sudo (not recommended) or configure npm to install globally without sudo:
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
Plugin Not Found
If a plugin command is not recognized:
- Check if the plugin is installed:
mediaproc list - Reinstall the plugin:
mediaproc add <plugin-name> - Check your PATH environment variable
Version Conflicts
If you experience issues after an update:
# Clear npm cache
npm cache clean --force
# Reinstall MediaProc
npm uninstall -g @mediaproc/cli
npm install -g @mediaproc/cli
See (Troubleshooting Guide)[./troubleshooting.mdx] here.
Next Steps
Now that MediaProc is installed, continue to the Quick Start guide to start processing media files.