{"id":31284840,"url":"https://github.com/flowm/grafana-sql-assistant","last_synced_at":"2026-05-05T08:31:11.856Z","repository":{"id":313119772,"uuid":"1050101533","full_name":"Flowm/grafana-sql-assistant","owner":"Flowm","description":"Grafana plugin that acts as SQL assistant to convert natural language to SQL queries, analyze database schemas, and seamlessly integrates with Grafana dashboards using LLM technology","archived":false,"fork":false,"pushed_at":"2025-09-04T01:39:15.000Z","size":281,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-04T03:26:09.554Z","etag":null,"topics":["assistant","grafana","postgres","sql"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Flowm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-09-04T00:31:36.000Z","updated_at":"2025-09-04T01:35:27.000Z","dependencies_parsed_at":"2025-09-04T03:26:34.143Z","dependency_job_id":"f0653a65-1d31-41db-a1d5-4beccd69d3f0","html_url":"https://github.com/Flowm/grafana-sql-assistant","commit_stats":null,"previous_names":["flowm/grafana-sql-assistant"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/Flowm/grafana-sql-assistant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flowm%2Fgrafana-sql-assistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flowm%2Fgrafana-sql-assistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flowm%2Fgrafana-sql-assistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flowm%2Fgrafana-sql-assistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Flowm","download_url":"https://codeload.github.com/Flowm/grafana-sql-assistant/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flowm%2Fgrafana-sql-assistant/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276713147,"owners_count":25691387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-24T02:00:09.776Z","response_time":97,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["assistant","grafana","postgres","sql"],"created_at":"2025-09-24T07:31:16.457Z","updated_at":"2025-09-24T07:32:36.618Z","avatar_url":"https://github.com/Flowm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SQL Assistant - Grafana Plugin\n\nSQL Assistant is an AI-powered Grafana app plugin that helps you write SQL queries for dashboards and panels through natural language conversation. It can access your database to understand the schema and assist with creating and updating dashboards.\n\nFor detailed documentation, features, and usage instructions, see the [plugin README](src/README.md).\n\n## What are Grafana app plugins?\n\nApp plugins can let you create a custom out-of-the-box monitoring experience by custom pages, nested data sources and panel plugins.\n\n## Get started\n\n### Frontend\n\n1. Install dependencies\n\n   ```bash\n   npm install\n   ```\n\n2. Build plugin in development mode and run in watch mode\n\n   ```bash\n   npm run dev\n   ```\n\n3. Build plugin in production mode\n\n   ```bash\n   npm run build\n   ```\n\n4. Run the tests (using Jest)\n\n   ```bash\n   # Runs the tests and watches for changes, requires git init first\n   npm run test\n\n   # Exits after running all the tests\n   npm run test:ci\n   ```\n\n5. Spin up a Grafana instance and run the plugin inside it (using Docker)\n\n   ```bash\n   npm run server\n   ```\n\n6. Run the E2E tests (using Playwright)\n\n   ```bash\n   # Spins up a Grafana instance first that we tests against\n   npm run server\n\n   # If you wish to start a certain Grafana version. If not specified will use latest by default\n   GRAFANA_VERSION=11.3.0 npm run server\n\n   # Starts the tests\n   npm run e2e\n   ```\n\n7. Run the linter\n\n   ```bash\n   npm run lint\n\n   # or\n\n   npm run lint:fix\n   ```\n\n# Distributing your plugin\n\nWhen distributing a Grafana plugin either within the community or privately the plugin must be signed so the Grafana application can verify its authenticity. This can be done with the `@grafana/sign-plugin` package.\n\n_Note: It's not necessary to sign a plugin during development. The docker development environment that is scaffolded with `@grafana/create-plugin` caters for running the plugin without a signature._\n\n## Initial steps\n\nBefore signing a plugin please read the Grafana [plugin publishing and signing criteria](https://grafana.com/legal/plugins/#plugin-publishing-and-signing-criteria) documentation carefully.\n\n`@grafana/create-plugin` has added the necessary commands and workflows to make signing and distributing a plugin via the grafana plugins catalog as straightforward as possible.\n\nBefore signing a plugin for the first time please consult the Grafana [plugin signature levels](https://grafana.com/legal/plugins/#what-are-the-different-classifications-of-plugins) documentation to understand the differences between the types of signature level.\n\n1. Create a [Grafana Cloud account](https://grafana.com/signup).\n2. Make sure that the first part of the plugin ID matches the slug of your Grafana Cloud account.\n   - _You can find the plugin ID in the `plugin.json` file inside your plugin directory. For example, if your account slug is `acmecorp`, you need to prefix the plugin ID with `acmecorp-`._\n3. Create a Grafana Cloud API key with the `PluginPublisher` role.\n4. Keep a record of this API key as it will be required for signing a plugin\n\n## Signing a plugin\n\n### Using Github actions release workflow\n\nIf the plugin is using the github actions supplied with `@grafana/create-plugin` signing a plugin is included out of the box. The [release workflow](./.github/workflows/release.yml) can prepare everything to make submitting your plugin to Grafana as easy as possible. Before being able to sign the plugin however a secret needs adding to the Github repository.\n\n1. Please navigate to \"settings \u003e secrets \u003e actions\" within your repo to create secrets.\n2. Click \"New repository secret\"\n3. Name the secret \"GRAFANA_API_KEY\"\n4. Paste your Grafana Cloud API key in the Secret field\n5. Click \"Add secret\"\n\n#### Push a version tag\n\nTo trigger the workflow we need to push a version tag to github. This can be achieved with the following steps:\n\n1. Run `npm version \u003cmajor|minor|patch\u003e`\n2. Run `git push origin main --follow-tags`\n\n## Learn more\n\nBelow you can find source code for existing app plugins and other related documentation.\n\n- [Basic app plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/app-basic#readme)\n- [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference/plugin-jsonplugin-json)\n- [Sign a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowm%2Fgrafana-sql-assistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflowm%2Fgrafana-sql-assistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowm%2Fgrafana-sql-assistant/lists"}