Give your AI agent eyes to see the entire internet. Read & search Twitter, Reddit, YouTube, GitHub, Bilibili, XiaoHongShu — one CLI, zero API fees.
Install or update Agent Reach
For the AI doing the work. This one guide covers a fresh install, an update, and an upgrade from 1.5 or earlier. Run every command yourself. Each agent-reach command (1.6 and later) prints one JSON object; read ok, result and error.hint.
⚠️ The PyPI package named
agent-reachis NOT this project. Never install it from PyPI; only use the GitHub URL below.
0. Before you start
- You must be able to run terminal commands. If you can't, tell the user: "Please turn on command execution for me in my settings, then ask again."
- Is it already installed? Run
agent-reach version:- it prints JSON (1.6 and later) → go to Update.
- it prints a plain line like
Agent Reach v1.5.0→ go to Upgrade from 1.5 or earlier. agent-reachis not found → continue below.
uvmissing (uv --versionfails)? Tell the user: "I'm installing uv, a small tool that installs command-line programs. It needs no admin password." Then run:- macOS / Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh - Windows:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" - Still
uv: command not found? Open a new shell and try again.
- macOS / Linux:
1. Install and set up
uv tool install https://github.com/Panniantong/Agent-Reach/releases/latest/download/agent-reach.zip
agent-reach setup
agent-reach not found after install? Run uv tool update-shell and open a new shell.
setup turns on the default channels and installs the agent skill.
2. Report to the user
Show result.installation_report.markdown to the user as is. The program generates it; do not rewrite, reorder or add to it.
Update
agent-reach update
It upgrades the program, every added channel's tools and the skill. Tell the user each line of result.user_actions, and show result.installation_report.markdown as is when it is present. If it fails, error.hint holds the exact command to run.
Upgrade from 1.5 or earlier
1.6 is installed with uv; 1.5 was installed with pipx or pip. Tell the user: "This is a big upgrade. Your keys and settings are kept; I'm moving Agent Reach to the new installer." Then:
- Install uv if it is missing (see step 0).
- Install 1.6:
uv tool install --force https://github.com/Panniantong/Agent-Reach/releases/latest/download/agent-reach.zip - Open a new shell and check
agent-reach versionprints JSON. If it still prints the old line, runuv tool update-shell, open a new shell and check again. - Run
agent-reach setup. It keeps~/.agent-reach/config.yaml, removes the old Agent Reach program (only Agent Reach itself, never the user's other tools) and refreshes the skill for every AI. - Show
result.installation_report.markdownto the user as is. It explains what changed and which old channels they can add back.
Later
- The user just says what they want, e.g. "add Xiaohongshu" →
agent-reach add <channel>; "remove V2EX" →agent-reach remove <channel>. - Keys are entered by the user, e.g. a Groq key for Xiaoyuzhou transcription:
agent-reach configure groq-key. - Everything else (usage, login, browser) is covered by the installed skill.
Problems and rolling back: troubleshooting.md.