> 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FchV0cXDaI5eA94nd7iUZ%2Fimage.png?alt=media&amp;token=f94a9f7a-e387-4d1a-a75f-8a80380d1996" 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2F19pRSOVsPkMuH2dbnFMN%2Fimage.png?alt=media&amp;token=ef143c5a-80f2-4344-9926-0aacfd0c7605" 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FbtHbe3dIm9cp7jTROtb6%2Fimage.png?alt=media&amp;token=460ec26e-507b-4ba8-b66b-6a0d008bcf27" alt="" width="375"><figcaption></figcaption></figure>

To start the service: `sh start.sh`

<figure><img src="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FNLqGr3P1VFbcNNjVIen3%2Fimage.png?alt=media&amp;token=ecc90d8e-0ee9-4241-a251-d3c81d1b60cb" 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2F37Mv8xjIYFKpUMSVDUgm%2Fimage.png?alt=media&amp;token=9b132970-f805-4c03-b2d2-52f0c541a344" 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FwiVM9QfGW5kgYuybbXW7%2Fimage.png?alt=media&amp;token=cbd47da3-0ec1-4cbb-9e31-420d8aed6c68" 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="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FA36A4TAUOUl4baNg8vtP%2Fimage.png?alt=media&amp;token=62d2abe1-1e80-4e0d-9a3f-c646ae316674" alt="" width="563"><figcaption></figcaption></figure>

Copy the ComfyUI service address to the settings in ShellAgent:

<figure><img src="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FSF3GfXltH1hHEzyT9bBm%2Fimage.png?alt=media&amp;token=5883ade7-6801-4b5e-b03f-d3f31703dc37" alt=""><figcaption><p>Copy and fill out in the Environment</p></figcaption></figure>

<figure><img src="https://2975681513-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDtmZwLatyyBFLUK6P6Pj%2Fuploads%2FhF7pamkl6Iuicj3jcfzN%2Fimage.png?alt=media&amp;token=934bd9a2-323e-4ec0-ab70-8f5b2968b523" alt=""><figcaption><p>Find your MyShell_api key here and fill it in</p></figcaption></figure>
