open-index/open-npm huggingface dataset:
npm package: @saishnarvekar/plugin-elastic-devtool
Description: ![Backstage Logo](https://backstage.io/img/logo.svg)
Latest version: 0.1.2


# Elastic Dev Tool Plugin for Backstage (Frontend)

![Backstage Logo](https://backstage.io/img/logo.svg)

> [!TIP]
> Modern Elasticsearch query and management UI for Backstage.

---

## Overview

`@saishnarvekar/plugin-elastic-devtool` is a feature-rich Backstage plugin that brings Elasticsearch query, index, and cluster management directly into your developer portal. Designed for extensibility and ease of use, it empowers teams to interact with Elasticsearch from a unified interface.

---

## Features

- Query runner with syntax highlighting and auto-complete
- Result viewer (JSON, table, chart)
- Index browser and management
- Cluster health and stats dashboard
- Works with Backstage's permission and plugin system

---

## Installation

Add the plugin to your Backstage app:

```bash
yarn --cwd packages/app add @saishnarvekar/plugin-elastic-devtool
```

---

## Usage

Import and add the plugin page to your app's router (e.g. in `App.tsx`):

```tsx
import { ElasticDevToolPage } from '@saishnarvekar/plugin-elastic-devtool';

// ...existing code...
<Route path="/elastic-devtool" element={<ElasticDevToolPage />} />
```

Configure your Elasticsearch connection in `app-config.yaml`:

```yaml
elastic-devtool:
  elasticsearch:
    node: 'https://localhost:9200'
    username: 'elastic' # optional
    password: 'password' # optional
```

Start your Backstage app and navigate to `/elastic-devtool` in the sidebar.

---

## Development

To develop or test the plugin in isolation:

```bash
yarn start
```

This will launch a local Backstage instance with the plugin enabled for rapid iteration.

---

## Resources

- [Backstage Documentation](https://backstage.io/docs)
- [Elasticsearch Documentation](https://www.elastic.co/guide/index.html)
- [Backstage Plugin Authoring](https://backstage.io/docs/plugins/)

---

> [!IMPORTANT]
> For backend API support, see [`@saishnarvekar/plugin-elastic-devtool-backend`](https://www.npmjs.com/package/@saishnarvekar/plugin-elastic-devtool-backend).
npm package: @saishnarvekar/plugin-elastic-devtool-backend
Description: developing the plugin backend itself.
Latest version: 0.1.1

developing the plugin backend itself.

# Elastic Dev Tool Plugin for Backstage (Backend)

![Backstage Logo](https://backstage.io/img/logo.svg)

> [!TIP]
> Backend API for Elasticsearch management and query in Backstage.

---

## Overview

`@saishnarvekar/plugin-elastic-devtool-backend` provides the backend API and service layer for the Elastic Dev Tool plugin, enabling secure, robust Elasticsearch operations from your Backstage instance.

---

## Features

- REST API for Elasticsearch query and index management
- Secure proxy to your Elasticsearch cluster
- Cluster health and stats endpoints
- Built with Backstage backend best practices

---

## Installation

Add the backend plugin to your Backstage backend:

```bash
yarn --cwd packages/backend add @saishnarvekar/plugin-elastic-devtool-backend
```

---

## Usage

Register the plugin in your backend (e.g. in `packages/backend/src/index.ts`):

```ts
import { elasticDevToolPlugin } from '@saishnarvekar/plugin-elastic-devtool-backend';

const backend = createBackend();
// ...existing code...
backend.add(elasticDevToolPlugin());
```

Configure your Elasticsearch connection in `app-config.yaml`:

```yaml
elastic-devtool:
  elasticsearch:
    node: 'https://localhost:9200'
    username: 'elastic' # optional
    password: 'password' # optional
```

---

## Development

To run the backend plugin in isolation for development:

```bash
yarn start
```

This will launch a local backend server for rapid development and testing.

---

## Resources

- [Backstage Backend Plugins](https://backstage.io/docs/backend-system/)
- [Elasticsearch Node.js Client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/)
- [Backstage Plugin Authoring](https://backstage.io/docs/plugins/)

---

> [!IMPORTANT]
> Use together with [`@saishnarvekar/plugin-elastic-devtool`](../elastic-devtool/) for a complete frontend + backend solution.