> ## Documentation Index
> Fetch the complete documentation index at: https://docs.musique.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Musique Agent

> Install and configure the Musique Agent on Windows 10 or later.

## Download

Download the installer directly:

<CardGroup cols={2}>
  <Card title="Download (64-bit)" icon="download" href="https://musique-portal.s3.us-east-1.amazonaws.com/public/agent/install.exe">
    `install.exe` — Windows Installer (\~339 MB)
  </Card>

  <Card title="Download (32-bit)" icon="download" href="https://musique-portal.s3.us-east-1.amazonaws.com/public/agent/install-w7_32bit.exe">
    `install-w7_32bit.exe` — Windows Installer (\~8.6 MB)
  </Card>
</CardGroup>

***

## Requirements

| Requirement      | Minimum Version      |
| ---------------- | -------------------- |
| Operating System | Windows 10 or later  |
| Java             | Version 17 or higher |

<Note>
  Don't have Java? The installer will detect this and provide a download link automatically.
</Note>

### Check your Java version

Open **Command Prompt** and run:

```bash theme={null}
java -version
```

If you see `version "17"` or higher, you're good to go.

***

## How to Install

<Steps>
  <Step title="Run the installer">
    Double-click `install.exe`.

    If Windows asks *"Do you want to allow this app to make changes?"* → click **Yes**.
  </Step>

  <Step title="Welcome">
    Click **Next** to begin.
  </Step>

  <Step title="Requirements check">
    The installer automatically checks if Java 17+ is installed.

    * ✅ Green checkmark — requirement met, click **Next**
    * ❌ Red cross — Java is missing or outdated → click **Download Java 17**, install it, then click **Check Again**
  </Step>

  <Step title="Authentication">
    Enter your **Musique username and password** and click **Next**.

    The installer will verify your credentials before continuing.
  </Step>

  <Step title="Destination folder">
    Choose where to install Musique Agent. The default location is:

    ```
    C:\Program Files\Musique Agent
    ```

    Click **Browse** to choose a different folder, then click **Next**.
  </Step>

  <Step title="Settings">
    Configure your preferences:

    * ☑ **Start Musique Agent with Windows** — the app will launch automatically on every Windows login (recommended)

    Click **Next** to continue.
  </Step>

  <Step title="Installing">
    The installer will copy files, save your credentials securely, and set up automatic startup.

    Wait for the progress bar to reach 100%, then click **Finish**.

    Musique Agent will launch automatically when done.
  </Step>
</Steps>

***

## How to Run

After installation, Musique Agent starts **automatically**.

* If you enabled **Start with Windows**, it will launch on every login without any action needed.
* To start it manually, navigate to your install folder and run:

```
C:\Program Files\Musique Agent\run.exe
```

<Note>
  If the app crashes, it will **automatically restart within 1 minute** via Windows Task Scheduler — no manual action needed.
</Note>

***

## How to Change Login Credentials

If your Musique username or password changes, update the credentials file manually:

<Steps>
  <Step title="Open the config folder">
    Navigate to:

    ```
    C:\Program Files\Musique Agent\config\
    ```
  </Step>

  <Step title="Edit config.json">
    Open `config.json` with any text editor (e.g. Notepad).

    ```json theme={null}
    {
      "username": "your-username",
      "password": "your-password"
    }
    ```

    Update the values and save the file.
  </Step>

  <Step title="Restart the app">
    Reboot your PC, or:

    1. Open **Task Manager**
    2. Find `javaw.exe` → **End Task**
    3. The app will restart automatically within 1 minute
  </Step>
</Steps>

***

## Where to Find Logs

Application logs are stored inside your install directory:

```
C:\Program Files\Musique Agent\logs\
```

<Note>
  The `logs` folder is created during installation. If you don't see any files yet, the app may not have generated any logs yet.
</Note>

If you need to report an issue, include the contents of this folder.

***

## How to Uninstall

<Steps>
  <Step title="Open the install folder">
    Navigate to:

    ```
    C:\Program Files\Musique Agent\
    ```
  </Step>

  <Step title="Run the uninstaller">
    Double-click `Uninstaller.exe`.

    If Windows asks *"Do you want to allow this app to make changes?"* → click **Yes**.
  </Step>

  <Step title="Confirm and complete">
    Click **Uninstall** in the confirmation dialog, wait for the process to complete, then click **OK**.

    The uninstaller will stop the app, remove the automatic startup task, and delete all installed files.

    <Warning>
      Your credentials in `config\config.json` will also be deleted. If you reinstall later, you will need to enter your credentials again.
    </Warning>
  </Step>
</Steps>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="&#x22;Java not found&#x22; during install">
    Install Java 17+ from the link provided in the installer, then click **Check Again**.
  </Accordion>

  <Accordion title="&#x22;Invalid username or password&#x22;">
    Check your Musique credentials and try again. If the issue persists, contact support.
  </Accordion>

  <Accordion title="App not starting automatically">
    Open **Task Scheduler** and check for a task named `MusiqueAgent`. If it's missing, reinstall the agent.
  </Accordion>

  <Accordion title="App keeps crashing">
    Check the `logs` folder for error details and include them when contacting support.
  </Accordion>

  <Accordion title="Can't uninstall">
    Right-click `Uninstaller.exe` and select **Run as administrator**.
  </Accordion>
</AccordionGroup>