> For the complete documentation index, see [llms.txt](https://docs.myshell.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.myshell.ai/create/shellagent-mode/installation.md).

# Download and Installation

{% hint style="info" %}
We now provide a [**ShellAgent cloud version**](https://shellagent.myshell.ai) for all creators. Enjoy building your AI Agent online!
{% endhint %}

Download ShellAgent for local installation: <https://github.com/myshell-ai/ShellAgent/releases>

<figure><img src="/files/DujzdTSWcjHUiSh1N0UT" alt=""><figcaption><p>ShellAgent cloud version</p></figcaption></figure>

## Download and install ShellAgent

### Install on Windows

* After extracting the files, navigate to the main directory and double-click `run.bat`. This will automatically install the necessary dependencies.
* Once you see the specified address in the command prompt, click `run.bat` again in the main directory.
* Wait for the initialization to complete, then open your browser and go to <http://localhost:8099>.

<figure><img src="/files/VNjjcu8gmgdyOlhm0nra" alt="" width="563"><figcaption></figcaption></figure>

### Install on macOS or Linux

* Extract the contents and enter the main directory.
* Open a terminal and run the following commands:

To install dependencies: `sh install.sh`

<figure><img src="/files/JTDgcCKLfZ6BtMcLrdvo" alt="" width="375"><figcaption></figcaption></figure>

To start the service: `sh start.sh`

<figure><img src="/files/Lh0KAiQwDYk0eChpjuPF" alt="" width="375"><figcaption></figcaption></figure>

* Once the process is complete, visit <http://localhost:8099> in your browser.

### Update

To enable automatic updates:

* Go to **Settings** and turn on the auto-update option.
* This ensures the application updates automatically every time you open it.

<figure><img src="/files/jAO94HhM6UHMryCisSB3" alt="" width="563"><figcaption></figcaption></figure>

If the auto-update option is unavailable, download the latest version of ShellAgent here.

{% embed url="<https://github.com/myshell-ai/ShellAgent/releases>" %}

## Other preparation

Visit the ComfyUI homepage to download and install [ComfyUI](https://github.com/comfyanonymous/ComfyUI).

<figure><img src="/files/myreFH3eokGHJVyGUuro" alt="" width="375"><figcaption></figcaption></figure>

## Setting Up the ShellAgent Plugin for ComfyUI

There are two methods, as follows:

1. Download or `git clone` <https://github.com/myshell-ai/ComfyUI-ShellAgent-Plugin> repository content to the `ComfyUI/custom_nodes/` directory.
   1. In the custom\_nodes directory, use the `git clone <https://github.com/myshell-ai/ComfyUI-ShellAgent-Plugin.git>` command to install
   2. In the ShellAgent-Plugin directory, use `pip install -r requirements.txt` to install dependencies
2. Search for ShellAgent using ComfyUI-Manager, click to install
3. Restart ComfyUI, start building the workflow

## Notice

Using ComfyUI Widget requires starting ComfyUI outside of ShellAgent.

<figure><img src="/files/CQyKgUt09SsKNAKtmMye" alt="" width="563"><figcaption></figcaption></figure>

Copy the ComfyUI service address to the settings in ShellAgent:

<figure><img src="/files/jd9EAVPCK3Ukie3YyPp6" alt=""><figcaption><p>Copy and fill out in the Environment</p></figcaption></figure>

<figure><img src="/files/rQblNvgFept5Q640NDYc" alt=""><figcaption><p>Find your MyShell_api key here and fill it in</p></figcaption></figure>
