Quickstart Agents through the CLI

Quickstart: Creating an Agent with TradeMindAI Framework

Welcome to the TradeMindAI Framework! This guide walks you through installing the CLI, setting up your environment, and creating your first AI agent.

---

1. Prerequisites

Before you begin, make sure you have:

• Node.js v20 or newer 👉 Download Node.js

• Internet connection Required to access the TradeMind API.

---

2. Installation

Clone the Repository

git clone https://github.com/your-org/thetrademind-fw.git
cd thetrademind-fw

Install Dependencies

npm install

Build the Project

npm run build

(Optional) Link the CLI Globally

This allows you to run the CLI from anywhere:

npm link

---

3. Running the CLI

You can start the CLI in two ways:

Development Mode

npm run dev

Production Mode (after build)

npm run start

You will be greeted with an interactive prompt.

---

4. Creating a New Agent

At the CLI prompt, type:

create

You will be guided through a series of prompts:

• Agent Name (must be unique)

• Personality (e.g., "Friendly and analytical")

• Description (e.g., "Expert in financial markets and trading strategies")

• Model (choose from the list below)

• Logo URL (optional)

Example:

Agent Name: MarketGuru
Personality: Analytical and Strategic
Description: Expert in DeFi and on-chain market analysis
Model: gpt-4o
Logo URL: (optional)

---

5. Listing All Agents

To see all your created agents, type:

list

---

6. Interacting with an Agent

To start a conversation with an agent:

MarketGuru

Type your messages and receive responses in real-time.

• Type exit or back to return to the main menu.

---

7. Other Useful Commands

• Help:

help

Lists all available commands.

• Quit:

quit

Exits the CLI (or press Ctrl+C).

---

8. Supported Models

You can choose from a variety of LLMs when creating your agent:

• gpt-4

• gpt-4o

• claude-3.7-sonnet

• claude-3-opus

• mistral-7b-instruct

• llama-3-70b-chat

• llama-3-8b-instruct

• gemini-2.5-pro

• anthropic-claude-3-haiku

• deepseek-R1-v3

---

9. Troubleshooting

• Ensure your Node.js version is v20 or newer.

• If you encounter issues, try running the CLI with:

npm run dev

for verbose debug output.

• For API or network errors, check your internet connection.

---

10. Contributing & Support

Found a bug or want to request a feature? 👉 Open an issue on GitHub

✨ Contributions are welcome!

---

11. License

This project is licensed under the MIT License.