MyShell
  • About MyShell
    • What is MyShell
    • MyShell in a Nutshell
    • Quickstart
  • Explore AI Agents
    • Image Generation
    • Video Generation
    • Meme Generation
    • Role-Playing Game
    • Character
    • Utility
  • Create AI Agents
    • Classic Mode
      • Enhanced Prompt
      • Knowledge Base
      • Telegram Integration
    • Pro Config Mode
      • Core Concepts
      • Tutorial
        • Tutorial Structure
        • Hello World with Pro Config
        • Building Workflow
        • Transitions
        • Expressions and Variables
        • Integration with Any Widget
        • An Advanced Example
      • Basic
        • Common
        • Atomic State
        • Transition
        • Automata
        • Modules
      • Advanced
        • Cron Pusher
        • Neutral Language To SD Prompt
        • Advanced Input Validation
        • Advanced Memory Manager in Prompt Widget
      • Tools
        • AutoConfig Agent
        • Cache Mode
        • Knowledge Base Agent
        • Crawler Widget
      • Example
        • Homeless With You
        • Random Routing
        • Function Calling
      • API Reference
        • Atomic State
        • Transition
        • Automata
        • Context
        • Module
          • AnyWidget Module
            • Prompt Widget
            • LLM Widget
            • TTS Widget
            • Code Runner Widget
            • Melo TTS
            • Age Transformation
            • ChatImg
            • GIF Generation
            • Music Generation
          • LLM Module
          • LLM Function Module
          • TTS Module
          • Google Search Module
        • Widgets
          • Bark TTS
          • Champ
          • CoinGecko
          • ControlNet with Civitai
          • Crawler
          • Crypto News
          • Data Visualizer
          • Email Sender
          • Google Flight Search
          • Google Hotel Search
          • Google Image Search
          • Google Map Search
          • Google News Search
          • Google Scholar Search
          • Google Search
          • GroundedSAM
          • Image Text Fuser
          • Information Extractor - OpenAI Schema Generator
          • Information Extractor
          • Instagram Search
          • JSON to Table
          • LinkedIn
          • MS Word to Markdown
          • Markdown to MS Word
          • Markdown to PDF
          • Mindmap Generator
          • Notion Database
          • OCR
          • Pdf to Markdown
          • RMBG
          • Stabel-Video-Diffusion
          • Stable Diffusion Inpaint
          • Stable Diffusion Recommend
          • Stable Diffusion Transform
          • Stable Diffusion Upscale
          • Stable Diffusion with 6 fixed category
          • Stable Diffusion with Civitai
          • Storydiffusion
          • Suno Lyrics Generator
          • Suno Music Generator
          • Table to Markdown
          • TripAdvisor
          • Twitter Search
          • UDOP: Document Question Answering
          • Weather forecasting
          • Whisper large-v3
          • Wikipedia
          • Wolfram Alpha Search
          • Yelp Search
          • YouTube Downloader
          • YouTube Transcriber
          • Youtube Search
      • FAQs
      • Changelog
    • ShellAgent Mode
      • Download and Installation
      • App Builder
      • Workflow
      • Build Custom Widget
      • Publish to MyShell
      • Customized Pricing For Your Agent
      • Example
        • Child Book X Agent w/ DeepSeek
        • Kids Book NFT AI Agent w/ BNB Chain
        • DeFAI Agent w/ BNB Chain
  • Shell Launchpad
    • How to Launch a Token
    • Trade Agent Tokens
  • Tokenomics
    • $SHELL Basics
    • $SHELL Token Utility
    • How to Obtain $SHELL
    • Roadmap
  • Open-source AI Framework/SDK
    • ShellAgent
    • OpenVoice
    • MeloTTS
    • JetMoE
    • AIlice
  • Links
Powered by GitBook
On this page
  • Download and install ShellAgent
  • Install on Windows
  • Install on macOS or Linux
  • Update
  • Other preparation
  • Setting Up the ShellAgent Plugin for ComfyUI
  • Notice
  1. Create AI Agents
  2. ShellAgent Mode

Download and Installation

PreviousShellAgent ModeNextApp Builder

Last updated 4 months ago

We now provide a ShellAgent cloud version for all creators. Enjoy building your AI Agent online!

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

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.

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

To start the service: sh start.sh

  • 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.

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

Other preparation

Visit the ComfyUI homepage to download and install ComfyUI.

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.

Copy the ComfyUI service address to the settings in ShellAgent:

Releases · myshell-ai/ShellAgentGitHub
Logo
ShellAgent cloud version
Copy and fill out in the Environment
Find your MyShell_api key here and fill it in