tavily-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -0
- package/dist/index.js +2760 -0
- package/package.json +33 -0
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# tavily-cli
|
|
2
|
+
|
|
3
|
+
CLI for the Tavily AI search API. Search, extract, crawl, and map the web. Made with [api2cli.dev](https://api2cli.dev).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g tavily-cli
|
|
9
|
+
# or
|
|
10
|
+
npx tavily-cli --help
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Setup
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
tavily-cli auth set "tvly-YOUR_API_KEY"
|
|
17
|
+
tavily-cli auth test
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Get your API key at [tavily.com](https://tavily.com).
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
### Search the web
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
tavily-cli search query "latest AI news"
|
|
28
|
+
tavily-cli search query "climate change" --topic news --time-range week
|
|
29
|
+
tavily-cli search query "rust programming" --answer advanced --max-results 10
|
|
30
|
+
tavily-cli search query "pricing" --depth advanced --include-domains example.com
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Extract content from URLs
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
tavily-cli extract url https://example.com
|
|
37
|
+
tavily-cli extract url https://a.com https://b.com --query "pricing info"
|
|
38
|
+
tavily-cli extract url https://example.com --depth advanced --json
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Crawl websites
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
tavily-cli crawl url https://docs.example.com
|
|
45
|
+
tavily-cli crawl url https://example.com --max-depth 3 --limit 100
|
|
46
|
+
tavily-cli crawl url https://example.com --instructions "Find pricing pages" --json
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Map website structure
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
tavily-cli map url https://docs.example.com
|
|
53
|
+
tavily-cli map url https://example.com --max-depth 3 --limit 100 --json
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Global Flags
|
|
57
|
+
|
|
58
|
+
All commands support: `--json`, `--format <fmt>` (text, json, csv, yaml), `--verbose`, `--no-color`, `--no-header`
|
|
59
|
+
|
|
60
|
+
## Development
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
git clone https://github.com/pyrytakala/tavily-cli.git
|
|
64
|
+
cd tavily-cli
|
|
65
|
+
bun install
|
|
66
|
+
bun run dev -- search query "test"
|
|
67
|
+
```
|