🥛 milkbucket

Milkbucket is an internal CLI tool by Modcafe for tooling, debugging, and managing Minecraft mods and datapacks.

It is built with Node.js and JavaScript.

---

Installation

1. Install Node.js and npm

Milkbucket requires Node.js and npm.

macOS

Using Homebrew:

brew install node

Verify the installation:

node --version
npm --version

Windows

Using winget:

winget install OpenJS.NodeJS

Verify the installation:

node --version
npm --version

Linux

On Debian/Ubuntu-based distributions:

sudo apt update
sudo apt install nodejs npm

Verify the installation:

node --version
npm --version

---

2. Install Milkbucket

Install Milkbucket globally from npm:

npm install -g @modcafe/milkbucket

Once installed, the milkbucket command is available globally.

---

3. Verify the installation

Check whether Milkbucket is available:

milkbucket --version

You can also display the available commands:

milkbucket --help

---

Commands

This section documents all available Milkbucket commands.

help

Displays a list of available commands and their descriptions.

milkbucket help

Aliases:

milkbucket -h
milkbucket --help

---

version

Displays the installed Milkbucket version.

milkbucket version

Aliases:

milkbucket -v
milkbucket --version

---

info (coming soon)

Displays information about the current project and environment.

milkbucket info

---

project (coming soon)

Tools for inspecting and working with the current Minecraft project.

milkbucket project

project detect (coming soon)

Detects the type and configuration of the current project.

milkbucket project detect

project validate (coming soon)

Checks the current project for common configuration problems.

milkbucket project validate

---

build (coming soon)

Builds the current Minecraft project.

milkbucket build

---

deps (coming soon)

Tools for inspecting project dependencies.

milkbucket deps

deps list (coming soon)

Lists the dependencies of the current project.

milkbucket deps list

deps check (coming soon)

Checks whether the project's dependencies are valid.

milkbucket deps check

---

logs (coming soon)

Tools for working with Minecraft logs.

milkbucket logs

logs latest (coming soon)

Displays or analyzes the latest log.

milkbucket logs latest

---

crash (coming soon)

Analyzes the latest Minecraft crash report.

milkbucket crash

---

team (coming soon)

Tools for Modcafe development teams.

milkbucket team

team doctor (coming soon)

Checks the local development environment.

milkbucket team doctor

---

Updating

Update Milkbucket directly through npm:

npm update -g @modcafe/milkbucket

To install the latest version regardless of the currently installed version:

npm install -g @modcafe/milkbucket@latest

You can verify the installed version afterwards:

milkbucket --version

---

Development

Milkbucket is developed using Node.js and JavaScript.

The repository is structured roughly as follows:

milkbucket/
├── cli.js
├── package.json
├── commands/
│   ├── help.js
│   ├── version.js
│   └── ...
└── lib/
    ├── commandInfo.js
    └── ...

New commands should be added to the commands/ directory and registered in the command metadata.

---

License

Internal Modcafe tooling. MIT.