Synopsis
Basic Options
Help and Version
Display help text and exit
Display program version and exitShows the launcher version, Git commit hash, and build information.
Data Directory
Use a custom directory as the application rootSpecial value:
Linux/macOS
Windows
Use current directory
This overrides the
PRISMLAUNCHER_DATA_DIR environment variable and the default data directory location.Instance Management
Launching Instances
Launch the specified instance by its IDThe instance ID is typically the folder name in your instances directory.
The launcher window will open and the instance will start automatically. Use with
--server or --world to join specific servers or worlds.Open the window for the specified instance without launching itThis opens the instance window, allowing you to configure settings before launch.
Launch Modifiers
These options modify how instances are launched and must be used in combination with--launch.
Join the specified world on launch (singleplayer)The world name must match exactly as it appears in the saves folder.
Requires Minecraft 1.20+ with quick play support. Only valid with
--launch.Account Selection
Use the account specified by its profile nameThe profile name is shown in the Accounts page of the launcher.
Launch in offline mode with the specified player name
This bypasses authentication and launches without a valid account. Only valid with
--launch.Resource Import
Import instance or resource from specified local path or URLSupported formats:
Local file
URL
Multiple imports
.mrpack- Modrinth modpacks.zip- CurseForge, ATLauncher, Technic modpacks- Modrinth URLs
- CurseForge URLs
Positional URL Arguments
You can also specify URLs as positional arguments (equivalent to--import):
Multiple URLs
Utility Options
Write a small This creates a file that can be used by external scripts to verify the launcher started successfully.The file location is in the data directory and contains the application ID.
live.check file after the launcher startsComplete Examples
Basic Launch Scenarios
Advanced Workflows
Automation Scripts
Desktop Shortcuts
Create desktop shortcuts for quick instance launching:Error Handling
Exit Codes
Success - Launcher started or command completed successfully
Failure - Syntax error, configuration error, or unexpected errorCommon causes:
- Invalid command-line arguments
- Instance not found
- Data directory inaccessible
- Missing required options (e.g.,
--serverwithout--launch)
Common Errors
Instance Communication
When a Prism Launcher instance is already running:- New commands are forwarded to the existing instance
- The new process exits after forwarding the command
- The existing launcher window handles the request
- Launching multiple instances from scripts
- Importing resources while launcher is open
- Remote control via command-line
Example: Import while launcher is running
Platform-Specific Notes
Linux AppImage
When running from AppImage:$APPIMAGE environment variable is automatically set and used for updates.
Windows Portable
For portable installations:portable.txt file in the launcher directory.
macOS Bundle
Access the binary inside the app bundle:open:
Integration Examples
Game Server Management
Launch on server start
Mod Testing Workflow
Automated Modpack Updates
Debugging
Enable verbose logging:Linux/macOS
Windows
Limitations
Related Documentation
- Custom Commands - Automate tasks with pre/post-launch commands
- Environment Variables - Control launcher with environment variables
- Portable Mode - Use
--dirfor portable installations
