Agent Skills › tavily-ai/skills › tavily-cli

tavily-cli

GitHub

提供Tavily CLI的安装、认证及命令使用指南,支持网页搜索、内容提取、站点爬取和深度研究等Web数据获取任务。

skills/tavily-cli/SKILL.md tavily-ai/skills

触发场景

用户询问Tavily CLI安装或设置 需要进行网页搜索或内容提取 需要配置Tavily API密钥或处理认证问题

安装

npx skills add tavily-ai/skills --skill tavily-cli -g -y
更多选项

不安装直接使用

npx skills use tavily-ai/skills@tavily-cli

指定 Agent (Claude Code)

npx skills add tavily-ai/skills --skill tavily-cli -a claude-code -g -y

安装 repo 全部 skill

npx skills add tavily-ai/skills --all -g -y

预览 repo 内 skill

npx skills add tavily-ai/skills --list

SKILL.md

Frontmatter
{
    "name": "tavily-cli",
    "description": "Set up, authenticate, update, troubleshoot, or choose between Tavily CLI web commands. Use when the user asks about the Tavily CLI, installing Tavily skills, first-time setup, authentication, keyless limits, CLI updates, or which Tavily command to use. For an ordinary web task, use the specific search, extract, map, crawl, research, or dynamic-search skill instead.\n",
    "allowed-tools": "Bash(tvly *)"
}

Tavily CLI

Web search, content extraction, site crawling, URL discovery, and deep research. Returns JSON optimized for LLM consumption.

Requires tavily-cli. Search and extract support capped keyless access; map, crawl, and research require authentication.

Run tvly --help or tvly <command> --help for full option details.

Setup

If tvly is not installed:

curl -fsSL https://cli.tavily.com/install.sh | bash

Or manually: uv tool install tavily-cli / pip install tavily-cli

For agent setup, start keyless unless the user asks to sign in or the requested task needs map, crawl, or research. If the installer did not already complete setup, run:

tvly init --skip-auth

This installs or updates the Tavily skills and verifies a live keyless search. Do not look for an API key or authenticate before the first search or extract request.

When authentication is requested or required, use guided setup:

tvly init

# Prefer to open the sign-in link yourself
tvly init --no-browser

tvly init reuses an existing credential, installs or updates the Tavily skills bundled with that CLI release, and verifies a live search. Run tvly update first when refreshing bundled skills. Use tvly init --skip-skills when the skills are already installed and only authentication or verification is needed.

Search and extract can run immediately without authentication, subject to a keyless rate-limit cap. If either command reaches that cap in an interactive session, run tvly login to open browser OAuth, then retry the original command once. In an unattended environment, report the cap and authentication options instead of starting an interactive flow. Map, crawl, and research require authentication. Check the current state only when needed with tvly --status --json.

For authentication without full setup, use tvly login, tvly login --no-browser, tvly login --api-key tvly-YOUR_KEY, or TAVILY_API_KEY.

Browser-based OAuth is the preferred interactive sign-in method. --no-browser simply prints the sign-in link instead of opening it automatically; the flow still returns to a localhost callback on the machine running tvly. In remote sessions, make sure that callback is reachable (SSH may require port forwarding). In an unattended agent or CI environment, leave authentication to the user or use a securely provided TAVILY_API_KEY, then resume the original command.

Keep an existing installation current with tvly update --check and tvly update.

Workflow

Follow this escalation pattern — start simple, escalate when needed:

  1. Search — No specific URL. Find pages, answer questions, discover sources.
  2. Extract — Have a URL. Pull its content directly.
  3. Map — Large site, need to find the right page. Discover URLs first.
  4. Crawl — Need bulk content from an entire site section.
  5. Research — Need comprehensive, multi-source analysis with citations.
Need Command When
Find pages on a topic tvly search No specific URL yet
Get a page's content tvly extract Have a URL
Find URLs within a site tvly map Need to locate a specific subpage
Bulk extract a site section tvly crawl Need many pages (e.g., all /docs/)
Deep research with citations tvly research Need multi-source synthesis

For detailed command reference, use the individual skill for each command (e.g., tavily-search, tavily-crawl) or run tvly <command> --help.

Run tvly without a subcommand for the interactive REPL.

Output

Search, extract, crawl, map, and research support --json for structured output. Result-producing commands support -o to save the JSON response; crawl also supports --output-dir for one Markdown file per page. Setup, authentication, status, and update commands expose --json where documented but do not support -o.

tvly search "react hooks" --json -o results.json
tvly extract "https://example.com/docs" -o docs.json
tvly crawl "https://docs.example.com" --output-dir ./docs/

Tips

  • Always quote URLs — shell interprets ? and & as special characters.
  • Use --json for agentic workflows when the selected command exposes it.
  • Read from stdin with - — echo "query" | tvly search -
  • Exit codes: 0 = success, 1 = setup/update failure, 2 = bad input, 3 = auth error, 4 = API or live-verification error.

版本历史

  • 778122e 当前 2026-09-09 08:45

    优化Agent设置流程,优先使用免认证模式;澄清交互式OAuth引导说明;强化工作流文档以对齐引导式CLI设置。

  • ea5e820 2026-07-25 07:40

同 Skill 集合

skills/tasks/tavily-entity/SKILL.md
skills/tavily-best-practices/SKILL.md
skills/tavily-dynamic-search/SKILL.md
skills/tavily-extract/SKILL.md
skills/tavily-map/SKILL.md
skills/tavily-research/SKILL.md
skills/core/tavily-search/SKILL.md
skills/tasks/tavily-list/SKILL.md
skills/tasks/tavily-monitor/SKILL.md
skills/tasks/tavily-research/SKILL.md
skills/tavily-crawl/SKILL.md
skills/tavily-search/SKILL.md

元信息

文件数
0
版本
778122e
Hash
f7b8f34b
收录时间
2026-07-25 07:40

首页 - Wiki
Copyright © 2011-2026 iteam. Current version is 2.156.0. UTC+08:00, 2026-11-18 15:27
浙ICP备14020137号-1