Agent-Reach/docs/install.md
Panniantong c851bd64b9 simplify: auto-everything in install command
Changes:
1. browser-cookie3 now in default deps (no separate pip install)
2. install --env=auto now auto-imports cookies on local computers
3. install auto-detects EXA_API_KEY from environment variables
4. install.md cut from 100 lines to 60 lines — two steps not five

Before: pip install → agent-eyes install → 'want search?' → 'want cookies?' → configure each
After: pip install → agent-eyes install (does everything automatically) → only ask about what's missing

Docker clean-room test: all passing, 0 bugs.
2026-02-24 08:37:55 +01:00

80 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Agent Eyes — Installation Guide
## For Humans
Copy this to your AI Agent:
```
帮我安装 Agent Eyeshttps://raw.githubusercontent.com/Panniantong/agent-eyes/main/docs/install.md
```
---
## For AI Agents
### Step 1: Install
```bash
pip install https://github.com/Panniantong/agent-eyes/archive/main.zip || pip3 install https://github.com/Panniantong/agent-eyes/archive/main.zip
agent-eyes install --env=auto
```
This single command does everything automatically:
- Detects local computer vs server
- Auto-imports browser cookies on local (Twitter, XiaoHongShu, Bilibili)
- Auto-detects Exa API key if already in environment
- Tests all channels
- Shows what's working and what needs setup
**Read the output carefully.** It tells you exactly what happened and what's next.
### Step 2: Only if needed — configure what's missing
Based on the install output, you may need to configure one or two things.
Only ask the user for items the install output says are missing.
**If search is not configured:**
> "Want to unlock web search? Go to https://exa.ai → sign up (free) → send me the API key."
```bash
agent-eyes configure exa-key THE_KEY
```
**If cookies were not auto-imported (server users):**
> "To unlock Twitter and XiaoHongShu, install the Cookie-Editor Chrome extension, go to the site, click Export → Header String, and paste it to me."
> Extension: https://chromewebstore.google.com/detail/cookie-editor/hlkenndednhfkekhgcdicdfddnkalmdm
```bash
agent-eyes configure twitter-cookies "PASTED_STRING"
agent-eyes configure xhs-cookie "PASTED_STRING"
```
**If on server and wants Reddit/Bilibili full access:**
> "Reddit and Bilibili block server IPs. Get a proxy at https://webshare.io ($1/month) and send me the address."
```bash
agent-eyes configure proxy http://user:pass@ip:port
```
### Step 3: Verify
```bash
agent-eyes doctor
```
Report what's active. Users can configure more anytime by asking.
---
## Quick Reference
| Command | What it does |
|---------|-------------|
| `agent-eyes install --env=auto` | Full auto-setup |
| `agent-eyes doctor` | Show status |
| `agent-eyes configure exa-key KEY` | Unlock search |
| `agent-eyes configure twitter-cookies "..."` | Unlock Twitter |
| `agent-eyes configure xhs-cookie "..."` | Unlock XiaoHongShu |
| `agent-eyes configure proxy URL` | Unlock Reddit + Bilibili (server) |
| `agent-eyes read URL` | Read any URL |
| `agent-eyes search "query"` | Search the web |