Quick Start¶

Get DeskAgent running in 5 minutes.

Before You Begin¶

Make sure you have:

• Windows 10 or 11
• Microsoft Outlook installed (optional, for email features)
• Internet connection
• An AI API key (Claude or Gemini)

Installation¶

The installer includes everything you need - Python, Git, and all dependencies.

1. Download DeskAgent-Setup.exe from the releases page

2. Run the installer

   • Right-click → "Run as administrator" if prompted
   • Accept the default installation location or choose your own

3. Wait for setup (2-5 minutes)

   • Python environment is configured automatically
   • All dependencies are installed
   • Default configuration files are created

4. Setup Complete

   After installation, you'll see the setup complete screen:

A DeskAgent shortcut appears on your desktop. Double-click to start.

License Activation¶

DeskAgent requires a license to run. You can start with a Trial license or activate a Full license.

Trial License (Free)¶

The Trial license is automatically active after installation. It includes:

• Full functionality for 14 days
• All features and integrations
• No credit card required

Full License¶

To activate a purchased license:

1. Open Settings (gear icon in the top-right corner)
2. Go to the License tab
3. Enter your Invoice Number and Email (from your purchase)
4. Click Activate License

Configuration¶

Add AI API Key¶

The setup wizard guides you through API key configuration:

Alternatively, you can edit config/backends.json directly:

{
  "claude_sdk": {
    "type": "claude_agent_sdk",
    "api_key": "sk-ant-api03-YOUR-KEY-HERE",
    "model": "claude-sonnet-4-20250514",
    "use_anonymization_proxy": true
  }
}

{
  "gemini": {
    "type": "gemini_adk",
    "api_key": "AIzaSy-YOUR-KEY-HERE",
    "model": "gemini-2.5-pro"
  }
}

Configure Extensions (Optional)¶

For billing, support, or document management, edit config/apis.json:

{
  "billomat": {
    "enabled": true,
    "id": "your-account-id",
    "api_key": "your-api-key"
  },
  "userecho": {
    "enabled": true,
    "subdomain": "your-subdomain",
    "api_key": "your-api-key"
  }
}

Start DeskAgent¶

Using the Shortcut¶

Double-click the DeskAgent shortcut on your desktop.

Using Command Line¶

cd deskagent
python server.py

Or use the start script:

.\deskagent\start.bat

What Happens¶

1. The server starts on port 5005
2. A native window opens (or browser tab if WebView is disabled)
3. You see the DeskAgent interface

Your First Task¶

Let's verify everything works with a simple test.

Test 1: Chat with the AI¶

1. Type in the chat:

   What can you help me with?
   

2. Expected result: The AI responds with a list of its capabilities.

Test 2: Try an Agent (If Outlook is available)¶

1. Open Microsoft Outlook and select an email
2. In DeskAgent, click Agents → Read Email
3. Expected result: DeskAgent reads and summarizes the selected email

Test 3: Explore Available Agents¶

1. Click Agents in the sidebar
2. Browse the available agents
3. Hover over each to see what it does

Quick Reference¶

Starting & Stopping¶

Configuration Files¶

Logs Location¶

Troubleshooting¶

DeskAgent won't start¶

AI not responding¶

Outlook issues¶

Next Steps¶