AI-agent friendly CLI for Yandex Search API — web search and YandexGPT generative search from the terminal.
Project description
yandex-search-cli
CLI for Yandex Search API and YandexGPT — web search and generative AI search from your terminal.
What it does
yandex-search wraps the Yandex Search API in two terminal commands. It is the practical way to query Yandex — the dominant search engine for Russian-language content — from scripts, pipelines, and AI agent workflows.
yandex-search performs web search and returns structured results: title, URL, domain, publication date, and text passages. yandex-gen uses YandexGPT to answer a question and cite the sources it used.
Both commands output clean --json for use in scripts and AI agents.
Who it is for
- Developers building automation pipelines over Russian-language web content
- AI agent developers who need structured search output from Yandex
- Researchers working with Russian-language sources,
.rudomains, or Yandex Cloud - Anyone using Claude Code, Codex, Cursor, or Windsurf who needs Yandex access from the terminal
Features
- Web search via Yandex with domain, date, and passage metadata
- Generative search via YandexGPT — answers with cited sources
- Filter results by domain (
--site) - Search
.ru,.com, and regional Yandex indexes - Paginate results (
--page) - Filter by region code
- Clean
--jsonoutput for every command
Installation
uv tool install yandex-search
No
uv? Runcurl -LsSf https://astral.sh/uv/install.sh | sh, or usepip install yandex-search-cli.
Quick start
You need a Yandex Cloud account with Search API enabled (quickstart):
mkdir -p ~/.search-api
echo '{"apiKey": "your-key", "folderId": "your-folder-id"}' > ~/.search-api/config.json
yandex-search "smart city digital platform"
Or via env vars:
export YANDEX_API_KEY=... && export YANDEX_FOLDER_ID=...
Usage
# Web search
yandex-search "smart city digital platform monograph"
# Restrict to a domain
yandex-search "async python" --site habr.com
# Search the .com Yandex index, more results
yandex-search "machine learning" -t com -n 20
# Generative answer with cited sources
yandex-gen "explain the difference between monolith and microservices"
# Restrict generative search to a domain
yandex-gen "how to configure nginx" --site nginx.org
# JSON — extract all URLs
yandex-search "topic" --json | jq -r '.[].url'
# JSON — filter results by domain pattern
yandex-search "regulations" --json \
| jq '[.[] | select(.domain | test("gov\\.ru"))]'
All flags — yandex-search:
| Flag | Default | Description |
|---|---|---|
-n / --num-results |
10 |
Number of results |
-t / --type |
ru |
Search index: ru · com · tr · kk · be · uz |
-r / --region |
— | Region code (e.g. 213 for Moscow) |
-p / --page |
0 |
Page number, zero-indexed |
--site |
— | Restrict results to this domain |
--json |
off | JSON array: [{title, url, domain, date, passages}] |
All flags — yandex-gen: --site, --json
AI agent usage
yandex-search is stateless, read-only, and designed to be called by AI coding assistants (Claude Code, Codex, Cursor, Windsurf, etc.).
# Search and extract URLs
yandex-search "topic" --json | jq -r '.[].url'
# Collect results across multiple pages
for page in 0 1 2; do
yandex-search "query" -p $page --json
done | jq -s 'add'
# Generative answer as JSON
yandex-gen "question" --json | jq '.message.content'
JSON schema for yandex-search --json:
[
{
"title": "Page title",
"url": "https://example.ru/page",
"domain": "example.ru",
"date": "2024-03-15",
"passages": ["Relevant text snippet..."]
}
]
See AGENTS.md for full schemas, exit codes, and environment reference.
Project metadata
- Author: Nolan Vale
- Brand: Nolan Vale Tools
- Focus: search automation, Yandex Search, AI-agent tooling, Russian web workflows, developer productivity
- License: MIT
Built by Nolan Vale
Part of Nolan Vale Tools — practical open-source utilities for search, automation, AI agents, and developer workflows.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yandex_search_cli-0.1.3.tar.gz.
File metadata
- Download URL: yandex_search_cli-0.1.3.tar.gz
- Upload date:
- Size: 24.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9efd8dac7303ea8fc20112bc23a5f46d9d456a1a41fae2822dc92364a2a38ba7
|
|
| MD5 |
42517f17b62fa9f07f0d8fa58f28775e
|
|
| BLAKE2b-256 |
fd499f94ce6954f973407a751f036408f6014dbe8a2e882f84eb9ef79e2b7105
|
File details
Details for the file yandex_search_cli-0.1.3-py3-none-any.whl.
File metadata
- Download URL: yandex_search_cli-0.1.3-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4fc047a0127dfa0ab458969e9ecbef8454b5c605f601c6130b93abcc6a36df3c
|
|
| MD5 |
2ee52f704bcc4b30ffb66ac35a5f836e
|
|
| BLAKE2b-256 |
7b139fe915d8319d6a20b924f01b285660db3224f8174200e1060539005508f5
|