bytees

Run Elasticsearch DSL queries against ByteES clusters across multiple VRegions via Kibana or DataQ backends.

Updated Apr 30, 2026
One-click install
npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bytees-yuezhen-huang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bytees
Source: https://github.com/yuezhen-huang/my-bytedance-skillhub/tree/main/bytees
Command: npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bytees-yuezhen-huang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Querying ByteES (Elasticsearch) clusters normally requires manually opening Kibana Dev Tools, handling SSO authentication, and knowing which gateway serves each region. This Skill lets you run ES DSL queries directly from the CLI across Singapore-Central, US-East, US-EastRed, EU-TTP2, US-TTP, and US-TTP2 clusters with automatic backend routing and credential caching. ## Core Features & Use Cases - Multi-region ES queries: Execute raw Elasticsearch DSL (search, cat indices, term/match queries) against any ByteES cluster PSM, with automatic routing to Kibana Console Proxy or DataQ backends based on VRegion. - Zero-click authentication: One-time bootstrap extracts the SSO cookie bundle from your local browser, runs the OAuth2 chain, and caches gdpr credentials with automatic refresh before expiry. - Use Case: An engineer needs to inspect documents in the byte.es.entity_platform cluster to debug a production issue. They run a single gdpa-cli run bytees command with a match_all DSL body and get parsed JSON hits back immediately, without opening a browser. ## Quick Start Ask the agent to query the byte.es.entity_platform ByteES cluster for the five most recent documents in your index using a match_all search.

Frequently Asked Questions about bytees

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run an Elasticsearch query on a ByteES cluster from the command line?

Run gdpa-cli run bytees with a JSON input containing cluster_psm, path, and an optional DSL body. The CLI routes the request to the correct Kibana or DataQ backend based on the vregion parameter and returns parsed JSON results.

Which ByteES regions use Kibana versus DataQ backends?

Singapore-Central and US-East use the I18N Kibana gateway, US-EastRed and EU-TTP2 use the EU Kibana gateway, and US-TTP and US-TTP2 use DataQ. DataQ regions require an explicit index and DSL body in the request.

How do I authenticate to ByteES Kibana without browser login each time?

Run gdpa-cli bytees bootstrap once to extract the SSO cookie bundle from your local Chrome or Edge browser. The CLI completes the OAuth2 chain, caches gdpr credentials in ~/.gdpa_cache/bytees/, and auto-refreshes them before expiry.

Why does ByteES bootstrap fail with session cookies not found?

This error means the browser has no active Kibana login session or it has expired. Open the Kibana URL in your browser, complete SSO login until Dev Tools renders, then rerun the bootstrap command.

Can I use the bytees skill to write or delete Elasticsearch documents?

The skill is intended for read-only query operations such as _search and _cat/indices. Although the underlying Kibana Console Proxy can technically pass write methods, the skill documentation explicitly restricts usage to read paths.