How to properly use this Duo-Bot repository - Step-by-step guide needed

[HiddenKeyDev]

Hi! I'm new to GitHub Actions and automation. Could someone provide a detailed step-by-step guide on how to use this repository?

• What happens after I fork the repository?
• How do I know if the automation is working correctly?
• Are there any logs I can check to verify the bot is running?
• What should I expect to see in my Duolingo account?

[storedesign]

🤖 Complete Duo-Bot Setup Guide - Step by Step

Hey @HiddenKeyDev! Great question! I've been working with GitHub Actions for 5+ years, so let me walk you through this completely.

⚠️ Important Disclaimer First

Please be aware: Duolingo actively monitors for automation and can permanently ban accounts. Use this at your own risk and consider using a test account first.

Step 1: What Happens After You Fork?

When you fork this repository:

• ✅ You get your own copy of all the bot code
• ✅ GitHub Actions workflows are copied but disabled by default
• ❌ You still need to configure your credentials
• ❌ The bot won't run automatically yet

First things to do:

1. Go to your forked repo's Actions tab
2. Click "I understand my workflows, go ahead and enable them"
3. You should see the workflow files listed (usually .github/workflows/*.yml)

Step 2: Setting Up Your Credentials

You'll need to add your Duolingo credentials as GitHub Secrets:

1. In your forked repo, go to: Settings → Secrets and variables → Actions
2. Click "New repository secret"
3. Add these secrets (exact names matter!):

   DUOLINGO_TOKEN → your_duolingo_api_token
   

For detailed instructions on how to get your Duolingo API token, check out:
👉 How to Get Duolingo Token - Discussion Guide

Screenshot: Settings → Secrets page showing where to add these

Step 3: How to Know If Automation Is Working

GitHub Actions Status Indicators:

• 🟢 Green checkmark = Bot ran successfully
• 🔴 Red X = Something failed
• 🟡 Yellow circle = Currently running
• ⚪ Gray circle = Waiting to run

Where to check:

1. Actions tab - Shows all workflow runs
2. Latest commit - Status icon next to latest commit
3. Email notifications (if enabled)

Step 4: Checking Logs (Essential!)

To see detailed logs:

1. Go to Actions tab
2. Click on any workflow run
3. Click on the job name (usually something like "Streak Automation")
4. Expand each step to see details

What successful logs look like:

{"percentage": 100, "status": "completed", "notification": {"icon": "checkmark", "head": "Successful", "body": "You received 10 Streaks. You can request up to 0 Streaks before your limit resets back to 10 Streaks in 4 hours.To boost your limits, <a href='https://duolingopro.net/patreon' target='_blank' style='font-family: Duolingo Pro Rounded; text-decoration: underline; color: #007AFF;'>donate</a>.", "duration": 15}}  

What failed logs look like:

{"percentage":0,"status":"rejected","max_amount":0,"notification":{"icon":"warning","head":"Limit Warning","body":"You can request up to 0 Streaks before your limit resets back to 10 Streaks in 3 hours and 59 minutes. To boost your limits, <a href='https://duolingopro.net/patreon' target='_blank' style='font-family: Duolingo Pro Rounded; text-decoration: underline; color: #007AFF;'>donate</a>.","duration":15}}

Screenshot: Actions tab showing successful run with green checkmarks

Step 5: What to Expect in Your Duolingo Account

Normal behavior (good signs):

• Gradual XP increases (10-50 XP per session)
• Maintained daily streak

Warning signs (stop immediately!):

• Massive XP jumps (500+ XP in minutes)
• Account warnings from Duolingo
• Locked account messages
• Unusual lesson patterns

Step 6: Scheduling (Based on the Workflow)

The bot typically runs on a schedule like:

schedule:
  - cron: '5 */4 * * *'  # Runs every 4 hours at minute 5 (UTC)

You can modify this in .github/workflows/duolingo.yml to:

• '0 9,15,21 * * *' - 9 AM, 3 PM, 9 PM daily
• '0 12 * * *' - Once daily at noon
• '*/30 * * * *' - Every 30 minutes (NOT recommended!)

Common Issues & Solutions

Problem: "Streak or XP Failed"

Solution:

• Double-check duolingo token in Secrets
• Make sure no special characters are causing issues

Problem: "Workflow didn't run"

Solution:

• Check if Actions are enabled
• Verify the cron schedule syntax
• Make sure secrets are named correctly

Problem: "Account locked"

Solution:

• Stop the automation immediately
• Wait 24-48 hours
• Consider reducing frequency

The community is here to help! 🚀

---

Remember: Use responsibly and respect Duolingo's Terms of Service!