Installation

Getting mucch up and running is straightforward. This guide will walk you through the installation process and verify your setup.

Prerequisites

Before installing mucch, ensure you have the following:

Installation Methods

Method 1: NPM Install (Recommended)

Install mucch globally to run it from anywhere:

$ npm install -g mucch

Or install locally in a project:

$ npm install mucch

Method 2: Using NPX (No Installation)

Run mucch without installing it permanently:

$ npx mucch

Verify Installation

After installation, verify that mucch is correctly installed:

$ mucch --versionmucch v1.0.0

Project Setup

Create a new directory for your mucch configuration:

$ mkdir my-mucch-bot$ cd my-mucch-bot$ touch .env

Your project structure should look like this:

my-mucch-bot/
└── .env          # Your configuration file

Troubleshooting

Permission Denied on macOS/Linux

If you encounter permission errors, install with sudo:

$ sudo npm install -g mucch

Node Version Issues

If you're using an older Node version, upgrade using nvm:

$ nvm install 20$ nvm use 20

Package Not Found

If npm can't find the package, ensure you're using the correct registry:

$ npm config get registryhttps://registry.npmjs.org/