coralogix-docs
coralogix/cx-cli
Search and read official Coralogix platform documentation with cx docs search and fetch.
What is coralogix-docs?
Access authoritative Coralogix product documentation to learn how features work, configure integrations, set up alerts, and navigate the UI. Use when users ask about platform capabilities, workflows, or setup—not for querying live tenant data.
- Search official Coralogix docs by keyword with cx docs search
- Fetch full documentation pages as markdown with cx docs fetch
- Find answers on UI workflows, integrations, and platform features
- Discover setup instructions for OpenTelemetry, agents, collectors, and webhooks
- Learn about alerts, SLOs, dashboards, and data exploration features
How to install coralogix-docs
npx skills add https://github.com/coralogix/cx-cli --skill coralogix-docsHow to use coralogix-docs
- 1.Run cx docs search with 2–4 focused keywords to find relevant documentation pages
- 2.Review the numbered results and identify the most relevant suffix (path)
- 3.Run cx docs fetch with the suffix to download the full page as markdown
- 4.Read the fetched content to answer the user's question
- 5.Fetch additional pages only if needed for context or related topics
Use cases
- A user asks how to view spans in Coralogix—search 'explore spans' and fetch the relevant guide
- Someone needs OpenTelemetry setup instructions—search 'OpenTelemetry' and fetch the integration docs
- A user wants to understand API key management—search 'API keys' and fetch the account access guide
- Someone is configuring alerts—search 'alerts' and fetch the feature documentation
- A user needs to know about trace-log correlation—search the concept and fetch the architecture docs
- Platform users learning Coralogix features and workflows
- DevOps engineers setting up integrations and collectors
- SREs configuring alerts, SLOs, and dashboards
- Teams implementing OpenTelemetry or other observability agents
- Anyone needing authoritative product documentation
coralogix-docs FAQ
No. These commands read public product documentation from coralogix.com/docs and do not require authentication or access to your tenant.
cx docs searches official documentation about how the platform works. cx logs and cx spans query your actual live tenant data. Use docs for 'how do I use this feature?' and telemetry commands for 'what data do I have?'
Use 2–4 focused keywords, not full sentences. For example, search 'explore spans' instead of 'how do I view spans in the website.' If no matches, try synonyms or broader terms.
Broaden or rephrase your query. Try the feature name plus category (e.g., 'spans UI' or 'OTel ingestion'). Increase --limit to see more results if the first page is ambiguous.
No. Use cx logs, cx spans, or cx metrics for live tenant data queries. The docs commands only provide product documentation and guidance.
Full instructions (SKILL.md)
Source of truth, from coralogix/cx-cli.
name: coralogix-docs
description: |
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.
metadata:
version: "0.1.0"
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
Related skills
More from coralogix/cx-cli and the wider catalog.
cx-ai-center
Observe, evaluate, and guard GenAI/LLM applications—analyze behavior, manage policies, and track costs.
cx-alerts
Manage Coralogix alert definitions—create, list, enable, disable, and configure alerts via CLI.
cx-cases
Triage and manage Coralogix Cases—acknowledge, assign, resolve, and track investigation timelines.
cx-cli
Cross-cutting behaviors and update notifications for all cx CLI commands.
cx-cost-optimization
Analyze and optimize Coralogix data costs through usage measurement, TCO policies, and retention management.
cx-dashboards
Build and deploy Coralogix dashboards from service telemetry via cx CLI.