Product Full-Text Search
lobehub/lobehub
Guides work on LobeHub's own product search: the shared search repository, provider choice, Elasticsearch mappings, change syncing and reindexing.
Help developers new to Elasticsearch get from zero to a working search experience.
Install Elasticsearch Onboarding
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install elastic/agent-skills elasticsearch-onboarding --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .claude/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .claude/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboardingType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install elastic/agent-skills elasticsearch-onboarding --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .agents/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .agents/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install elastic/agent-skills elasticsearch-onboarding --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .cursor/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .cursor/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/elastic/agent-skills.git --path skills/elasticsearch/elasticsearch-onboarding--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install elastic/agent-skills elasticsearch-onboarding --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .gemini/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .gemini/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install elastic/agent-skills elasticsearch-onboardingInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .github/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .github/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install elastic/agent-skills elasticsearch-onboarding --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/elastic/agent-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/elasticsearch/elasticsearch-onboarding .opencode/skills/elasticsearch-onboarding && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "elasticsearch-onboarding" agent skill from https://github.com/elastic/agent-skills/tree/main/skills/elasticsearch/elasticsearch-onboarding into .opencode/skills/elasticsearch-onboarding/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "elasticsearch-onboarding", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
elasticsearch-onboarding- GitHub stars
- 592
- Token cost
- ~665 tokens
- SKILL.md length
- 311 words
- Files
- 10 (incl. references)
- Skills in repo
- 26
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Help developers new to Elasticsearch get from zero to a working search experience.
- Shows intent to build search-related functionality
- SKILL.md covers Examples and Guidelines
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Asks about Elasticsearch-related concepts for their use case
What it does
Elasticsearch Onboarding is an agent skill from elastic/agent-skills, published by the product's own GitHub organization. Help developers new to Elasticsearch get from zero to a working search experience. Guide them through understanding their intent, mapping their data, and building a search experience with best practices baked in. Use this when the user shows intent to build search-related functionality, asks about Elasticsearch-related concepts for their use case, or expresses the need for help getting started with Elasticsearch.
Its SKILL.md is about 670 tokens, which your agent loads only when the skill is triggered. The skill folder holds 18 other files, including reference files (for example `references/catalog-ecommerce/ecommerce.md`, `references/code-generation/code-generation.md` and `references/elasticsearch-onboarding-playbook.md`). Compatibility notes: Elasticsearch 9.x
It sits in Backend & APIs, covering Search implementation. It works with Elasticsearch. The repository describes itself as: Official Elastic Skills. The licence is Apache-2.0.
When your agent uses it
- Shows intent to build search-related functionality
- Asks about Elasticsearch-related concepts for their use case
- Expresses the need for help getting started with Elasticsearch
Example prompts
- “/elasticsearch-onboarding”
Requirements
- Compatibility (from SKILL.md): Elasticsearch 9.x
What it can do on your machine
Read from SKILL.md and the folder at commit baa5111. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Compatibility
Elasticsearch 9.x
From compatibility in the SKILL.md frontmatter.
Context cost
Elasticsearch Onboarding loads about 665 tokens when it runs, and up to ~34k if it reads all its reference files. Until then it costs about 110 tokens; SKILL.md has 311 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from elastic/agent-skills at commit baa5111, republished under its Apache-2.0 licence (© elastic). 311 words, ~665 tokens.
Download SKILL.mdSave it as
.claude/skills/elasticsearch-onboarding/SKILL.md (or your agent's skills folder). This skill also uses 9 other files; get the full folder from GitHub.- name
- elasticsearch-onboarding
- description
- Help developers new to Elasticsearch get from zero to a working search experience. Guide them through understanding their intent, mapping their data, and building a search experience with best practices baked in. Use this when the user shows intent to build search-related functionality, asks about Elasticsearch-related concepts for their use case, or expresses the need for help getting started with Elasticsearch.
- compatibility
- Elasticsearch 9.x
- metadata.author
- elastic
- metadata.version
- 0.1.0
Elastic Developer Guide
You are an Elasticsearch solutions architect working alongside the developer. Your job is to guide developers from "I want search" to a working search experience — understanding their intent, recommending the right approach, and generating tested, production-ready code. Use the conversation playbook in references/elasticsearch-onboarding-playbook.md to structure the conversation. Always ask one question at a time, listen for signals, and adapt your recommendations to their specific use case and data shape.
Examples
Example user intents that should trigger this skill:
- "I want to build a search experience for my e-commerce site"
- "How do I get started with Elasticsearch?"
- "What are the best practices for building a search experience?"
- "Can you help me understand how to model my data for search?"
- "How do I build a vector database?"
- "I want to build a RAG pipeline with Elasticsearch"
- "How do I use EIS for embeddings?"
- "How do I connect an LLM to Elasticsearch?"
- "How do I do kNN search in Elasticsearch?"
- "How do I use ELSER for semantic search?"
- "How do I set up the Elasticsearch MCP?"
- "How do I combine keyword and vector results with RRF?"
- "I want NLP-powered search"
- "What's the difference between BM25 and vector search?"
- "Can I use ES|QL to query my data?"
Guidelines
- Ask one question at a time, then wait.
- Only generate code once the user confirms the approach and the mapping.
- Use the Synonyms API for synonym management, not a custom-built solution.
- Always use a versioned index name + alias (e.g.
products_v1+products_current) and explain why. - Explain decisions briefly, assume the user does not understand Elasticsearch yet.
- Always go through the mapping walkthrough — it's the most expensive thing to change later.
- Ask what programming language the user wants to use, don't assume.
- Avoid generating code with deprecated APIs. If you must use a deprecated API for some reason, explain why and warn about future compatibility issues.
© elastic, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 9 other files (references) in skills/elasticsearch/elasticsearch-onboarding of elastic/agent-skills.
- SKILL.md
- references/catalog-ecommerce/ecommerce.md
- references/code-generation/code-generation.md
- references/elasticsearch-onboarding-playbook.md
- references/keyword-search/keyword-search.md
- references/mcp-setup/mcp-setup.md
- references/rag-chatbot/rag-chatbot.md
- references/search-ui/search-ui.md
- references/use-case-library/use-case-library.md
- references/vector-hybrid-search/vector-hybrid-search.md
Open the folder on GitHubat commit baa5111
Compare with similar skills
Elasticsearch Onboarding next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Elasticsearch Onboarding this skillelastic/agent-skills | 592 | — | ~665 | Automated safety check: Pass | Apache-2.0 | |
| Product Full-Text Searchlobehub/lobehub | 83k | — | ~4.1k | Automated safety check: Pass | Custom licence | |
| Foundatio Repositoriesexceptionless/Exceptionless | 2.5k | — | ~1.9k | Automated safety check: Pass | Apache-2.0 | |
| Elasticsearch Authnaspectrr/deer | 405 | — | ~1.2k | Automated safety check: Notes | MIT | |
| Elasticsearch Authzaspectrr/deer | 405 | — | ~1.8k | Automated safety check: Pass | MIT | |
| Elasticsearch File Ingestaspectrr/deer | 405 | — | ~684 | Automated safety check: Pass | MIT |
Similar skills
Foundatio Repositories
exceptionless/Exceptionless
Query, aggregate, patch, or paginate Exceptionless data through its Elasticsearch repository abstractions.
Elasticsearch Authn
aspectrr/deer
Authenticate to Elasticsearch using native, file-based, LDAP/AD, SAML, OIDC, Kerberos, JWT, or certificate realms.
Elasticsearch Authz
aspectrr/deer
Manage Elasticsearch RBAC: native users, roles, role mappings, document- and field-level security.
Elasticsearch File Ingest
aspectrr/deer
Ingest and transform data files (CSV/JSON/Parquet/Arrow IPC) into Elasticsearch with stream processing and custom transforms.
Elasticsearch Security Troubleshooting
aspectrr/deer
Diagnose and resolve Elasticsearch security errors: 401/403 failures, TLS problems, expired API keys, role mapping mismatches, and Kibana login issues.
More from elastic/agent-skills
All 26 skills in this repo- Official
Security Alert Triage
elastic/agent-skills
Triage Elastic Security alerts — gather context, classify threats, create cases, and acknowledge.
- Official
Security Case Management
elastic/agent-skills
Create, search, update, and manage SOC cases via the Kibana Cases API.
- Official
Security Detection Rule Management
elastic/agent-skills
Create, tune, and manage Elastic Security detection rules (SIEM and Endpoint).
- Official
Kibana Dashboards
elastic/agent-skills
Create and manage Kibana Dashboards and Lens visualizations.
- Official
Security Generate Security Sample Data
elastic/agent-skills
Generate sample security events, attack scenarios, and synthetic alerts for Elastic Security.
- Official
Cloud Onboarding
elastic/agent-skills
Onboard an Elastic Cloud organization: configure the elastic CLI's Cloud context and API key, establish a default region, then invite users, assign predefined or custom Serverless project roles, and…
Related
Works with
Categories
Questions about Elasticsearch Onboarding
What does Elasticsearch Onboarding do?
Help developers new to Elasticsearch get from zero to a working search experience. Elasticsearch Onboarding is an agent skill from elastic/agent-skills, published by the product's own GitHub organization. Help developers new to Elasticsearch get from zero to a working search experience.
When should I use Elasticsearch Onboarding?
Elasticsearch Onboarding fits situations like: shows intent to build search-related functionality; asks about Elasticsearch-related concepts for their use case; expresses the need for help getting started with Elasticsearch.
How do I install Elasticsearch Onboarding in Claude Code?
Run `npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a claude-code`. Or copy the skill folder (skills/elasticsearch/elasticsearch-onboarding in elastic/agent-skills) into .claude/skills/elasticsearch-onboarding in your project. Claude Code loads it when a task matches its description.
How do I install Elasticsearch Onboarding in Codex?
Run `npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a codex`. Or copy the skill folder (skills/elasticsearch/elasticsearch-onboarding in elastic/agent-skills) into .agents/skills/elasticsearch-onboarding in your project. Codex loads it when a task matches its description.
Can I use Elasticsearch Onboarding in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add elastic/agent-skills --skill elasticsearch-onboarding -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/elasticsearch-onboarding, .gemini/skills/elasticsearch-onboarding, .github/skills/elasticsearch-onboarding and .opencode/skills/elasticsearch-onboarding in your project.
What does Elasticsearch Onboarding need to run?
SKILL.md names no scripts, command-line tools or credentials: Elasticsearch Onboarding is instructions for the agent only. Compatibility (from SKILL.md): Elasticsearch 9.x.
Does Elasticsearch Onboarding access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Elasticsearch Onboarding safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Elasticsearch Onboarding use?
Elasticsearch Onboarding is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Elasticsearch Onboarding use?
About 665 tokens (SKILL.md is roughly 2.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 33k tokens, read only when the agent opens those files.
What are the alternatives to Elasticsearch Onboarding?
Skills that share tags, products or a category with Elasticsearch Onboarding: Product Full-Text Search (lobehub/lobehub, 83k stars), Foundatio Repositories (exceptionless/Exceptionless, 2.5k stars), Elasticsearch Authn (aspectrr/deer, 405 stars) and Elasticsearch Authz (aspectrr/deer, 405 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Elasticsearch Onboarding?
elastic (a GitHub organization, an official publisher) maintains it in elastic/agent-skills, which has 592 GitHub stars. The repository holds 26 skills in this directory. The repository was last updated on October 7, 2026.
Source: elastic/agent-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.