Commands Overview

CLIcraft provides a comprehensive set of commands to manage your Minecraft instances and mods. This page provides a quick reference to all available commands.

📚 Command Categories

Instance Management

Commands for creating and managing Minecraft instances.

Command	Description
create	Create a new Minecraft instance with Fabric or Forge
info	View detailed information about an instance
launch	Launch a Minecraft instance
alias	Manage instance aliases for quick launching

Mod Management

Commands for finding, installing, and managing mods.

Command	Description
search	Search for mods on Modrinth
install	Install a mod to your instance
uninstall	Remove a mod from your instance
upgrade	Upgrade mods, Minecraft version, or mod loader

Authentication

Commands for managing your Microsoft account authentication.

Command	Description
auth	Manage Minecraft accounts (login, logout, switch, status)

Actions:

• clicraft auth login - Add a new account
• clicraft auth logout [account] - Remove an account
• clicraft auth switch [account] - Switch between accounts
• clicraft auth status - View all account statuses
• clicraft auth list - List saved accounts

Configuration

Commands for managing CLI and game settings.

Command	Description
config	Manage CLI settings and game settings

🔍 Quick Command Reference

Create a new instance

clicraft create

Interactive prompts will guide you through instance configuration.

Search for mods

clicraft search <query> [options]

Options:

• -l, --limit <number> - Number of results (default: 10)
• -v, --version <version> - Filter by Minecraft version
• --loader <loader> - Filter by mod loader (fabric, forge, quilt, neoforge)
• --verbose - Enable verbose output

Install a mod

clicraft install <mod> [options]

Options:

• -i, --instance <path> - Path to instance directory
• -f, --force - Force reinstall if already installed
• --verbose - Enable verbose output

Uninstall a mod

clicraft uninstall [mod] [options]

Options:

• -i, --instance <path> - Path to instance directory
• -f, --force - Skip confirmation prompt
• --verbose - Enable verbose output

If no mod is specified, shows interactive multi-select.

Authentication

clicraft auth [action] [args...]

Actions:

• login - Add a new Microsoft account
• logout [account] - Remove an account (interactive if no account specified)
• switch [account] - Switch to a different account
• status [account] - Show account status(es)
• list - List all saved accounts

Options:

• -f, --force - Skip confirmation prompts
• --verbose - Enable verbose output

Launch the game

clicraft launch [options]

Options:

• -i, --instance <path> - Path to instance directory
• --offline - Launch in offline mode
• --verbose - Enable verbose output

View instance info

clicraft info [options]

Options:

• -i, --instance <path> - Path to instance directory
• --verbose - Show detailed information

Upgrade mods or loader

clicraft upgrade [mod] [options]

Options:

• -i, --instance <path> - Path to instance directory
• -f, --force - Force upgrade
• --verbose - Enable verbose output

Manage settings

clicraft config [action] [args...] [options]

Actions:

• show - Show CLI settings (default)
• set <key> <value> - Set a CLI setting
• ignore - Show game settings ignore list
• ignore-add <pattern> - Add pattern to ignore list
• ignore-remove <pattern> - Remove pattern from ignore list
• defaults - Show default game settings for new instances
• defaults-set <key> <value> - Set a default game setting
• defaults-remove <key> - Remove a default game setting
• defaults-clear - Clear all default game settings
• capture - Capture game settings from options.txt
• game-settings - Show saved game settings
• clear-game-settings - Clear saved game settings

Options:

• -i, --instance <path> - Path to instance directory
• --verbose - Enable verbose output

💡 Common Workflows

Setting up a new modded Minecraft instance

# 1. Create a new instance
clicraft create

# 2. Navigate to instance directory
cd my-instance

# 3. Login to Microsoft (for online play)
clicraft login

# 4. Search for mods
clicraft search sodium

# 5. Install mods
clicraft install sodium
clicraft install lithium
clicraft install iris

# 6. Launch the game
clicraft launch

Managing an existing instance

# Check instance information
cd my-instance
clicraft info --verbose

# Update mods
clicraft upgrade

# Launch the game
clicraft launch

Working with multiple instances

# Install mod to specific instance
clicraft install sodium --instance ./instance1

# Launch specific instance
clicraft launch --instance ./instance2

# View info for specific instance
clicraft info --instance ./instance3

Sharing a modpack configuration

# Set up your instance with mods and settings
cd my-instance
clicraft install sodium
clicraft install lithium
# ... configure game settings in Minecraft ...

# Capture game settings
clicraft config capture

# Share your mcconfig.json
# Others can create the same setup:
mkdir new-instance && cd new-instance
cp /path/to/shared/mcconfig.json .
clicraft create
# CLIcraft will install everything from the config!

🎓 Learning More

Each command has detailed documentation with examples and options:

• create - Create instances
• search - Find mods
• install - Add mods to instances
• uninstall - Remove mods from instances
• login - Authentication
• launch - Start the game
• info - Instance details
• upgrade - Update mods and loaders
• config - Manage settings

🔧 Global Options

Most commands support these common options:

• --verbose - Enable detailed output for debugging
• --help - Show help for a specific command

Example:

clicraft install --help

🆘 Getting Help

For additional help:

• Use clicraft <command> --help for command-specific help
• Visit the GitHub repository for issues and discussions
• Check the configuration guide for advanced settings

---

← Back to Home

Installation →

---

Table of contents

• create
• search
• install
• auth
• uninstall
• launch
• info
• upgrade
• config
• alias