Skip to content

JienWeng/yappy

Repository files navigation

Yappy 🐶

AI-powered LinkedIn engagement assistant. Automatically discover LinkedIn posts and leave thoughtful, unique, AI-generated comments that actually sound like you.

Yappy Demo

License: MIT Python 3.11+

Yappy is a powerful terminal-based tool that uses Google's Gemini AI and Playwright browser automation to help you stay active on LinkedIn without the mindless scrolling.


Quickstart

Install Yappy using your favorite package manager:

pip (Recommended)

pip install yappy
yap

To run the program

yap              # Launch TUI dashboard
yap onboarding   # Manually run the setup wizard
yap --no-tui     # Run in headless CLI mode
yap --report     # Show activity report
yap --about      # Show version and system info

✨ Getting Started (Your First Run)

The first time you run yap, Yappy will launch with onboarding wizard to help you get set up in minutes. You can re-run this at any time using yap onboarding.

  1. Automatic Setup: Yappy will automatically install the necessary Playwright browser and create your configuration files.
  2. Your AI "Brain": You'll need a Google Gemini API key. They are currently free to get from Google AI Studio.
  3. Secure Login: Yappy will open a browser window for you to log in to LinkedIn. Your password is never seen or stored by Yappy. It securely saves your session "cookie" locally on your computer, so you stay logged in for future runs.
  4. Ready to Go: Once connected, Yappy is ready to start finding posts for you!

📺 Managing Your Bot

Yappy offers two ways to run, depending on whether you want to watch the magic happen or let it run quietly in the background.

1. The Yappy Dashboard (TUI)

Just run yap to open the interactive dashboard.

  • Live Feed: Watch in real-time as Yappy discovers posts and drafts thoughtful comments.
  • Stats Panel: Keep an eye on your daily progress and account health.
  • Current Strategy: See your active AI persona and targeting rules at a glance.
  • Configuration Editor: Tweak your settings, manage your Gemini API Key, and refresh your LinkedIn Login directly from within the terminal.

2. Background Mode (CLI)

If you prefer to let Yappy work while you focus on other things:

yap --no-tui

You can check on its progress anytime by running a report:

yap --report

Customization

Configuration is stored at ~/.config/yappy/config.yaml. You can customize your targets:

targets:
  - type: feed          # Your home feed
    max_posts: 15
  - type: keyword       # Specific topics
    value: "AI startups"
    max_posts: 5

Uninstall

To remove Yappy from your system:

1. Remove the package

pip uninstall yappy
# OR if installed via Homebrew:
brew uninstall yappy

2. Clean up local data (Optional)

To completely remove your configuration, LinkedIn session, and activity logs:

# macOS
rm -rf ~/Library/Application\ Support/yappy
rm -rf ~/.config/yappy

# Linux
rm -rf ~/.local/share/yappy
rm -rf ~/.config/yappy

License

Distributed under the MIT License. See LICENSE for more information.


Yappy is an independent project and is not affiliated with, authorized, maintained, sponsored, or endorsed by LinkedIn Corporation.

About

AI-powered LinkedIn engagement assistant

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors