install Command

Install mods from Modrinth directly to your Minecraft instance.

📝 Synopsis

clicraft install <mods...> [options]

📖 Description

The install command downloads and installs one or more mods from Modrinth to your Minecraft instance. It automatically:

Searches for the mod on Modrinth
Finds the correct version for your Minecraft version and loader
Downloads the mod file
Places it in your instance’s mods/ directory
Tracks the installation in your instance configuration

🎯 Arguments

Argument	Description	Required
`<mods...>`	One or more mod names or Modrinth project IDs	Yes (at least one)

🎯 Options

Option	Description	Default
`-i, --instance <path>`	Path to instance directory	Current directory
`-f, --force`	Force reinstall if already installed	false
`--verbose`	Enable verbose output	false

📋 Examples

Install from instance directory

cd my-instance
clicraft install sodium

Install with instance path

clicraft install sodium --instance ./my-instance

Force reinstall

clicraft install sodium --force

Useful for reinstalling a mod or downgrading to a different version.

Install using Modrinth ID

clicraft install AANobbMI

Use the project ID from clicraft search results.

Install multiple mods

cd my-instance
clicraft install sodium lithium iris

When installing multiple mods, you’ll see a summary at the end:

📊 Installation Summary:
   ✅ 3 mod(s) installed successfully

Verbose installation

clicraft install sodium --verbose

See detailed information about the download and installation process.

🎮 Example Session

$ cd my-fabric-instance
$ clicraft install sodium

Installing sodium...
✓ Found mod: Sodium
✓ Compatible version: sodium-fabric-mc1.21.1-0.6.0.jar
✓ Downloading...
✓ Installed successfully to ./mods/

Sodium has been installed!

Remember to restart Minecraft if it's currently running.

🔍 How It Works

1. Mod Search

The command searches Modrinth for the specified mod name or ID.

2. Version Selection

Automatically selects the best version based on:

Your instance’s Minecraft version
Your instance’s mod loader (Fabric/Forge)
Latest stable release for that configuration

3. Download

Downloads the .jar file from Modrinth’s CDN.

4. Installation

Places the mod in your mods/ directory and updates instance tracking.

📂 Installation Location

Mods are installed to:

instance-directory/
└── mods/
    ├── sodium-fabric-mc1.21.1-0.6.0.jar
    ├── lithium-fabric-mc1.21.1-0.6.0.jar
    └── iris-mc1.21.1-1.8.0.jar

🎯 Use Cases

Building a Performance Pack

cd my-instance
clicraft install sodium lithium starlight ferritecore

Adding Quality of Life Mods

cd my-instance
clicraft install jei journeymap appleskin

Installing Shader Support

cd my-instance
clicraft install sodium iris

Server Mods

cd my-server
clicraft install lithium starlight fabric-api

⚠️ Important Notes

Instance Detection

clicraft automatically detects your instance by looking for mcconfig.json:

If in instance directory, uses current directory
If using --instance, uses specified path
Must have a valid mcconfig.json file

Version Compatibility

The mod version is automatically matched to:

Your Minecraft version (from mcconfig.json)
Your mod loader (Fabric/Forge)
Latest compatible release

Dependencies

Some mods require other mods to work:

Sodium Extra requires Sodium
Iris requires Sodium
Many Fabric mods require Fabric API

Install dependencies separately:

clicraft install sodium
clicraft install "sodium extra"  # Now it will work

Mod Conflicts

Some mods conflict with each other:

Sodium conflicts with Optifine
Phosphor conflicts with Starlight

Research mod compatibility before installing.

🔍 Finding the Right Mod

Use clicraft search to find mods before installing:

# Search first
clicraft search optimization --version 1.21.1 --loader fabric

# Then install by name or ID
clicraft install sodium

⚠️ Common Issues

“Instance not found”

Make sure you’re either:

In an instance directory (contains mcconfig.json)
Using --instance to specify the path

# Check for mcconfig.json
ls mcconfig.json

# Or specify instance
clicraft install sodium --instance ./my-instance

“Mod not found”

The mod name might be incorrect:

Use clicraft search <term> to find the exact name
Try using the Modrinth project ID instead
Check spelling and capitalization

“No compatible version found”

The mod may not support your Minecraft version or loader:

Check mod compatibility on Modrinth
Try a different Minecraft version
Look for alternative mods

“Already installed”

The mod is already in your instance:

Use --force to reinstall
Use clicraft upgrade to update it
Check mods/ directory

Download Failures

If downloads fail:

Check your internet connection
Try again (downloads resume automatically)
Use --verbose for detailed error info

💡 Pro Tips

Install Fabric API First: Many Fabric mods require it
```
clicraft install "fabric api"
```
Check Dependencies: Read mod descriptions for required mods

Use Search First: Find the exact mod name before installing

clicraft search "just enough"
clicraft install "just enough items"

Backup First: Before installing many mods, backup your instance
Test Individually: Install and test mods one at a time to catch issues

📊 Verifying Installation

After installing, verify with:

# List installed mods
ls mods/

# View instance info
clicraft info

# Check in-game
clicraft launch
# Then check Mods menu in Minecraft

🔄 Updating Installed Mods

To update mods, use the upgrade command:

# Update a specific mod
clicraft upgrade sodium

# Update all mods
clicraft upgrade

🗑️ Removing Mods

To remove a mod, simply delete it from the mods/ directory:

cd my-instance
rm mods/sodium-*.jar

Or use a file manager to delete the mod file.

clicraft search - Find mods to install
clicraft info - View installed mods
clicraft upgrade - Update installed mods
clicraft create - Create an instance first

🔗 See Also

← Back to Commands

Next: login →