Getting Started
Quick Start Guide
Welcome to ReCloud! This guide will help you get up and running with the complete ReCloud system in just a few minutes.
Prerequisites
Before installing ReCloud, ensure you have:
- Node.js 18+ and npm installed
- Google Gemini API key (get one at Google AI Studio)
- Cursor IDE (recommended for MCP integration)
- Git for cloning repositories
Installation
1. Install Dependencies
npm install
2. Configure Environment
Create environment configuration:
cp .env.example .env
Edit .env:
GEMINI_API_KEY=your_api_key_here
PORT=3001
NODE_ENV=development
3. Start the System
# Start the complete system
npm run dev
# Or start individual components
npm run start:api # Start API server
npm run start:app # Start application
npm run start:tray # Start tray application
First Use
1. Configure API Key
- Launch the desktop application (you should see the tray icon)
- Right-click the tray icon and select "Settings"
- Enter your Google Gemini API key
- Configure agent behavior settings
2. Verify Installation
- Check tray icon shows green (system healthy)
- Open Cursor IDE
- Try a simple command like
@recloud analyze sentiment of "I love this product!"
3. Activate Tools
- In the desktop application, click "Tools" to open the tools dashboard
- Select the tools you want to use
- Click "Restart Server" to apply changes
Basic Usage
Simple Tool Execution
# In Cursor IDE, use MCP commands
@recloud analyzeSentiment "This product is amazing!"
@recloud generateCode "Create a Python function to calculate fibonacci numbers"
@recloud generateQR "https://recloud.dev"
Workflow Execution
# Complex multi-step workflows
@recloud analyzeSentiment and then generate a response email
Next Steps
- Read the Architecture Overview to understand the system
- Explore Core Components for detailed functionality
- Check Configuration for advanced setup options
- Review Tools Catalog for available capabilities
Troubleshooting
Common Issues
- Red tray icon: Check if API server is running on port 3001
- "Tool not found": Ensure tools are activated in desktop application settings
- API errors: Verify your Gemini API key is valid and has quota
Getting Help
- Check Common Issues for solutions
- Review FAQ for frequently asked questions
- Enable Debug Mode for detailed logging
Congratulations! You're now ready to harness the power of autonomous AI workflows with ReCloud.