diff --git a/deploy-manage/deploy/cloud-enterprise/tools-apis.md b/deploy-manage/deploy/cloud-enterprise/tools-apis.md index 1ba4a3b2b8..9d23eaac52 100644 --- a/deploy-manage/deploy/cloud-enterprise/tools-apis.md +++ b/deploy-manage/deploy/cloud-enterprise/tools-apis.md @@ -41,12 +41,26 @@ Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-a :::{include} /deploy-manage/deploy/_snippets/other-apis.md ::: +## Elastic CLI +```{applies_to} +deployment: + stack: preview +``` + +The Elastic CLI provides a single command-line interface for {{es}} and {{kib}} APIs. Use it to interact with {{es}} and {{kib}} in {{ece}} deployments. + +Refer to the [Elastic CLI documentation](cli://index.md) to install the CLI, configure a connection, and run example operations. Not all Elastic APIs are available as CLI commands. + +:::{note} +The Elastic CLI doesn't support the {{ece}} API. To manage deployments at the platform level, you can use [ecctl](#ecctl). +::: + ## {{es}} API Console [ece-api-console] :::{include} /deploy-manage/deploy/_snippets/cloud-api-console.md ::: -## {{ecloud}} Control: command-line interface for {{ecloud}} +## {{ecloud}} Control: command-line interface for {{ecloud}} [ecctl] :::{include} /deploy-manage/deploy/_snippets/ecctl.md ::: diff --git a/deploy-manage/deploy/cloud-on-k8s/tools-apis.md b/deploy-manage/deploy/cloud-on-k8s/tools-apis.md index fd33e27c74..5564f974eb 100644 --- a/deploy-manage/deploy/cloud-on-k8s/tools-apis.md +++ b/deploy-manage/deploy/cloud-on-k8s/tools-apis.md @@ -40,4 +40,5 @@ Refer to [{{es}} API conventions](elasticsearch://reference/elasticsearch/rest-a ## Tools -* [ECK diagnostics tool](/troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md): Use the `eck-diagnostics` command line tool to create a diagnostic archive to help troubleshoot issues with ECK. \ No newline at end of file +* [ECK diagnostics tool](/troubleshoot/deployments/cloud-on-k8s/run-eck-diagnostics.md): Use the `eck-diagnostics` command line tool to create a diagnostic archive to help troubleshoot issues with ECK. +* {applies_to}`stack: preview` [Elastic CLI](cli://index.md): Interact with the {{es}} and {{kib}} APIs of clusters managed by {{eck}}. diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md index c018cfe21e..1c06835618 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md @@ -16,6 +16,10 @@ For update workflows, the deployments API also provides dedicated operations for If you haven’t created an API key yet, then refer to [](../../api-keys/elastic-cloud-api-keys.md). +:::{tip} +:applies_to: ech: preview +For a command-line workflow, use the [Elastic CLI](cli://index.md) to run supported deployment operations. For an example of how to connect the CLI to {{ecloud}} and manage deployments, follow [Connect to {{ecloud}} with the Elastic CLI](cli://cli/manage-elastic-cloud.md). +::: ## Common operations with dedicated endpoints [ec_common_operations_with_dedicated_endpoints] diff --git a/deploy-manage/deploy/elastic-cloud/manage-serverless-projects-using-api.md b/deploy-manage/deploy/elastic-cloud/manage-serverless-projects-using-api.md index d54a8e9ba6..ae426438b9 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-serverless-projects-using-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-serverless-projects-using-api.md @@ -17,6 +17,11 @@ On this page, you can find examples of how to create and manage serverless proje - [Updating a project](#general-manage-project-with-api-update-project) - [Listing regions where projects can be created](#general-manage-project-with-api-list-available-regions) +:::{tip} +:applies_to: serverless: preview +For a command-line workflow, use the [Elastic CLI](cli://index.md) to run supported project operations. For an example of how to connect the CLI to {{ecloud}} and manage projects, follow [Connect to {{ecloud}} with the Elastic CLI](cli://cli/manage-elastic-cloud.md). +::: + To try the examples in this section, start by [setting up an API key](#general-manage-project-with-api-set-up-api-key). :::{agent-skill} diff --git a/deploy-manage/deploy/elastic-cloud/tools-apis.md b/deploy-manage/deploy/elastic-cloud/tools-apis.md index ab8f72a451..52d69d6cd1 100644 --- a/deploy-manage/deploy/elastic-cloud/tools-apis.md +++ b/deploy-manage/deploy/elastic-cloud/tools-apis.md @@ -77,6 +77,17 @@ The following APIs are available for {{ech}} users: :::{include} /deploy-manage/deploy/_snippets/other-apis.md ::: +## Elastic CLI +```{applies_to} +deployment: + ech: preview +serverless: preview +``` + +The Elastic CLI provides a single command-line interface for {{es}}, {{kib}}, and {{ecloud}} APIs. Use it to interact with {{es}} and {{kib}} in {{ech}} deployments and {{serverless-full}} projects, or to manage deployments and projects through the {{ecloud}} API. + +Refer to the [Elastic CLI documentation](cli://index.md) to install the CLI, configure a Cloud connection, and run example operations. Not all Elastic APIs are available as CLI commands. + ## {{ecloud}} API console ```{applies_to} deployment: diff --git a/deploy-manage/deploy/self-managed/tools-apis.md b/deploy-manage/deploy/self-managed/tools-apis.md index e9927359b5..d81d6c842a 100644 --- a/deploy-manage/deploy/self-managed/tools-apis.md +++ b/deploy-manage/deploy/self-managed/tools-apis.md @@ -34,6 +34,7 @@ Refer to [](/deploy-manage/api-keys/elasticsearch-api-keys.md) to learn how to g ## Tools +* {applies_to}`stack: preview` [Elastic CLI](cli://index.md): Interact with {{es}} and {{kib}} APIs from a single command-line interface. * [{{es}} command line tools](elasticsearch://reference/elasticsearch/command-line-tools/index.md): Utilities for configuring security and performing other tasks from the command line. * [{{kib}} command line tools](kibana://reference/commands.md): Utilities for performing security and connectivity related tasks for {{kib}} from the command line. * [{{es}} Support Diagnostic tool](/troubleshoot/elasticsearch/diagnostic.md): Captures a point-in-time snapshot of cluster statistics and most {{es}} settings for troubleshooting purposes. \ No newline at end of file diff --git a/docset.yml b/docset.yml index 31150af647..8ee2a4d4bc 100644 --- a/docset.yml +++ b/docset.yml @@ -113,6 +113,7 @@ cross_links: - apm-k8s-attacher - apm-server - beats + - cli - cloud - cloud-on-k8s - curator diff --git a/manage-data/data-store/manage-data-from-the-command-line.md b/manage-data/data-store/manage-data-from-the-command-line.md index 1e0ead7037..8248b1d8f4 100644 --- a/manage-data/data-store/manage-data-from-the-command-line.md +++ b/manage-data/data-store/manage-data-from-the-command-line.md @@ -14,6 +14,8 @@ products: Learn how to index, update, retrieve, search, and delete documents in an {{es}} cluster using APIs. +{applies_to}`stack: preview` {applies_to}`serverless: preview` The examples on this page use `curl`, but you can also use the [Elastic CLI](cli://index.md), which provides a command-line interface for {{es}} and {{kib}} APIs. + ::::{tip} For a user interface to query, visualize, and manage your {{es}} data, try [{{kib}}](/explore-analyze/index.md). {{kib}} provides visualization tools, index management, and sample data sets you can use to explore its capabilities. :::: diff --git a/reference/index.md b/reference/index.md index ad4a4414bf..0b69441fdf 100644 --- a/reference/index.md +++ b/reference/index.md @@ -41,6 +41,16 @@ Leverage the power of the cloud with Elastic Cloud solutions. Explore Elastic Cl **Learn more in [Cloud](cloud://reference/index.md)** +## Elastic CLI +```{applies_to} +stack: preview +serverless: preview +``` + +Interact with {{es}}, {{kib}}, and {{ecloud}} APIs from a single command-line interface. + +**Learn more in [Elastic CLI](cli://index.md)** + ## Elastic Security Access detailed reference documentation on field and object schemas as well as the different commands used to manage and troubleshoot Elastic Endpoint.