coralogix-docs
Search and read official Coralogix platform documentation using cx docs search and cx docs fetch. Use when the user asks how Coralogix features work, how to configure or use the UI, set up integrations (OpenTelemetry, agents, collectors, webhooks), manage API keys, explore spans/traces/logs in the product, configure alerts/SLOs/dashboards, or needs authoritative product docs — not live tenant telemetry.
- Installs
- 3.8K
- Last 24h
- +86
- Trending rank
- #2196
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/coralogix/cx-cli --skill coralogix-docs- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads coralogix-docs automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Coralogix docs (cx docs search, cx docs fetch)
These commands read official Coralogix product documentation from coralogix.com/docs. They answer how the platform works and how to configure or use it. They do not query your tenant's logs, spans, metrics, or alerts.
No Coralogix API key is required.
CLI commands
| Command | Purpose |
|---|---|
cx docs search <query> | Find doc pages by keyword. Returns numbered titles + path suffixes. |
cx docs fetch <suffix> | Download one page as markdown. Pass the suffix from search. |
Flags
| Flag | Commands | Description |
|---|---|---|
--limit | search | Max results, 1–20 (default 5) |
-o json / -o toon | both | Machine-readable output |
Examples
cx docs search "explore spans" --limit 5
cx docs search "OpenTelemetry traces"
cx docs fetch user-guides/data_exploration/spans/
cx docs search "API keys" -o json
When to use these commands
Use cx docs search + cx docs fetch when the user wants:
| Topic | Example questions |
|---|---|
| UI / workflows | "How do I view spans in Coralogix?", "Where is Explore spans?" |
| Ingestion & integrations | OpenTelemetry setup, agent/collector config, Send Your Data API keys |
| Platform features | Alerts, SLOs, dashboards, enrichments, parsing rules, retention |
| Concepts & architecture | How tracing works, trace-log correlation, data model |
| Account & access | API keys, SSO, roles, regions |
Prefer these commands over guessing when the answer depends on current Coralogix product behavior or UI navigation.
When not to use these commands
| User need | Use instead |
|---|---|
| Query live logs | cx logs — cx-telemetry-querying |
| Query live spans/traces | cx spans — cx-telemetry-querying |
| DataPrime syntax / commands | cx dataprime list / cx dataprime show — cx-telemetry-querying |
| Alerts & cases in the tenant | cx alerts, cx cases — cx-alerts, cx-cases |
| Metrics (PromQL) | cx metrics — cx-telemetry-querying |
| Discover field paths in tenant data | cx search-fields |
Standard workflow
cx docs searchwith a focused query (2–4 keywords, not full sentences).- Pick the most relevant suffix from the results.
cx docs fetchon that suffix.- Answer from the fetched content. Fetch additional pages only when needed.
User: "How do I show spans in the Coralogix website?"
1. cx docs search "explore spans" --limit 5
2. cx docs fetch user-guides/data_exploration/spans/
3. Summarize: Explore → spans dataset → Spans/Traces/Flows tabs → drilldown
Tips
cx docs search
- Start with 2–4 focused terms, not full sentences.
- If no matches, try synonyms or broader terms (
"tracing"instead of"distributed trace waterfall view"). - Increase
--limitwhen the first page of hits is ambiguous. - Results use path suffixes under
/docs/(not full URLs) — pass them directly tocx docs fetch.
cx docs fetch
- Pass the suffix from
cx docs search(e.g.user-guides/data_exploration/spans/). Full URLs are rejected. cx docs fetchone page at a time — pick the best match first.
Troubleshooting
| Problem | Action |
|---|---|
| No search matches | Broaden or rephrase the query; try feature name + category ("spans UI", "OTel ingestion"). |
| Fetched page is too narrow | Search for the parent topic or run a second search with related terms. |
| User wants their actual data | Switch to cx logs, cx spans, cx metrics, or alerts — docs describe the product, not tenant contents. |
Related
- Telemetry queries: cx-telemetry-querying
- Alerts: cx-alerts
- Dashboards: cx-dashboards
FAQ
What does the coralogix-docs skill do?
Search and read official Coralogix platform documentation using cx docs search and cx docs fetch. Use when the user asks how Coralogix features work, how to configure or use the UI, set up integrations (OpenTelemetry, agents, collectors, webhooks), manage API keys, explore spans/traces/logs in the product, configure alerts/SLOs/dashboards, or needs authoritative product docs — not live tenant telemetry.
How do I install coralogix-docs?
Run npx skills add https://github.com/coralogix/cx-cli --skill coralogix-docs in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/coralogix-docs/ (personal) or .claude/skills/coralogix-docs/ (project).
Which AI agents can use coralogix-docs?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is coralogix-docs safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains coralogix-docs?
It is published by coralogix in coralogix/cx-cli. It has 3,785 recorded installs.
More from coralogix/cx-cli
cx-telemetry-querying
coralogix/cx-cli
Use this skill for any question involving telemetry data: "investigate an issue", "debug a problem", "find out why something is slow", "check error rates", "analyze user behavior", "understand a production incident", "query telemetry data", "look at logs", "search logs", "find errors", "find stack traces", "filter by severity", "check traces", "examine spans", "investigate request latency", "debug service-to-service calls", "look up a trace ID", "analyze RUM data", "query rum.events", "check frontend performance", "frontend errors", "Core Web Vitals", "JavaScript exceptions", "query metrics", "check CPU usage", "run a PromQL query", "check error rate", "look up a metric", "check memory usage", "how do I write a DataPrime query", "DataPrime syntax", or wants to answer questions using observability data from logs, metrics, traces, RUM, or APM.
cx-search-dashboard
coralogix/cx-cli
This skill should be used when the user asks to "find a dashboard", "search dashboards", "does a dashboard exist for X", "find widgets that query Y", "which dashboards use this field", "find a dashboard about errors", "look up dashboards by description", "search for existing monitoring dashboards", "find widgets that reference a field", or wants to discover existing Coralogix dashboards or widgets using natural-language or field-based search.
cx-alerts
coralogix/cx-cli
This skill should be used when the user asks to "manage alerts", "create alert", "list alerts", "delete alert", "check alert status", "enable alert", "disable alert", "investigate firing alerts", "check which alerts are active", "find alerting rules", "set up an alert", "configure alerting", "mute an alert", "silence an alert", "see alert definitions", "check alert priority", or wants to manage Coralogix alert definitions using the cx CLI.
cx-cli
coralogix/cx-cli
This skill should be used whenever the user runs any cx command, uses the cx CLI, Coralogix CLI, or mentions cx in the context of Coralogix observability. This skill provides cross-cutting concerns like update notifications that apply to all cx commands.
cx-observability-setup
coralogix/cx-cli
Use this skill when the user asks to "set up monitoring", "configure observability", "onboard new service", "create saved view", "set up notifications", "configure webhook", "set up Slack integration", "outgoing webhook", "automation action", "webhook for alerts", "create view", "saved view", "view folder", "organize dashboards", "install integration", "configure extension", "contextual data", "connect external service", "create notification connector", "set up email alerts", "configure PagerDuty", "notification routing", "deploy extension", "test webhook", "notification preset", "test notification", "webhook actions", or wants to set up, configure, or manage the observability stack for a service or team.
cx-data-pipeline
coralogix/cx-cli
Use this skill when the user asks to "set up parsing", "create parsing rule", "extract fields from logs", "regex extraction", "log parsing", "enrich logs", "add context to logs", "custom enrichment table", "lookup table", "geo enrichment", "create metric from logs", "events to metrics", "convert logs to metrics", "generate metrics from events", "recording rule", "precomputed metrics", "PromQL recording", "configure data pipeline", "transform log data", "data processing rules", "rule group", "enrichment settings", "E2M definition", "labels cardinality", "bulk delete rules", "enrichment limits", "search enrichment table", "what should I convert to metrics", "E2M not producing metrics", "E2M no series", "reduce log cost with E2M", "logs to metrics aggregation", "spans to metrics", or wants to configure how Coralogix processes, enriches, or transforms ingested data.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.