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
Copy git clone https://github.com/your-org/thetrademind-fw.git
cd thetrademind-fw Install Dependencies
Build the Project
(Optional) Link the CLI Globally
This allows you to run the CLI from anywhere:
3. Running the CLI
You can start the CLI in two ways:
Development Mode
Production Mode (after build)
You will be greeted with an interactive prompt.
4. Creating a New Agent
At the CLI prompt, type:
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)
5. Listing All Agents
To see all your created agents, type:
6. Interacting with an Agent
To start a conversation with an agent:
Type your messages and receive responses in real-time.
Type exit or back to return to the main menu.
7. Other Useful Commands
Lists all available commands.
Exits the CLI (or press Ctrl+C).
8. Supported Models
You can choose from a variety of LLMs when creating your agent:
9. Troubleshooting
Ensure your Node.js version is v20 or newer.
If you encounter issues, try running the CLI with:
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 GitHubarrow-up-right
✨ Contributions are welcome!
This project is licensed under the MIT License .
Last updated 9 months ago
