Skip to content

Point the repo and plugin id at the quicknode org #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbarrau-qn merged 3 commits into from
Aug 31, 2026
Merged

Point the repo and plugin id at the quicknode org #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9b5dc4
Point the repo and plugin id at the quicknode org
sebastienb Aug 31, 2026
5cdd88d
Set the manifest author to Quicknode
sebastienb Aug 31, 2026
2e5a86e
Point the Admin API link at the admin-api docs
sebastienb Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion BarWidget.qml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import qs.Ui
// the panel straight into API key editing.
BarWidget {
id: root
moduleName: "io.github.sbarrau-qn.quicknode"
moduleName: "io.github.quicknode.quicknode"

function injectPanel() {
var target = panelLoader.item
Expand Down
4 changes: 2 additions & 2 deletions Panel.qml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import "Model.js" as Model
// addresses, and inline Admin API key management.
Panel {
id: root
moduleName: "io.github.sbarrau-qn.quicknode"
ipcTarget: "io.github.sbarrau-qn.quicknode"
moduleName: "io.github.quicknode.quicknode"
ipcTarget: "io.github.quicknode.quicknode"
manageIpc: false

property var anchorItem: null
Expand Down
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ billing period, with a popup listing your endpoints and their status.
- Left click toggles the popup, middle click refreshes, right click opens
the popup straight into API key editing.

Data comes from the [QuickNode Admin API](https://www.quicknode.com/docs/quicknode-api)
Data comes from the [QuickNode Admin API](https://www.quicknode.com/docs/admin-api)
(`/v0/usage/rpc`, `/v0/usage/rpc/by-chain`, and `/v0/endpoints`), which
requires a paid QuickNode plan. Copying uses `wl-copy`.

Expand All @@ -32,11 +32,11 @@ the theme foreground with `MultiEffect`.
## Install

```bash
omarchy plugin add https://github.com/sbarrau-qn/quicknode-omarchy-plugin.git --enable
omarchy plugin add https://github.com/quicknode/quicknode-omarchy-plugin.git --enable
```

Or by hand: copy this directory to `~/.config/omarchy/plugins/io.github.sbarrau-qn.quicknode/`,
then run `omarchy-shell shell rescanPlugins` and `omarchy plugin enable io.github.sbarrau-qn.quicknode`.
Or by hand: copy this directory to `~/.config/omarchy/plugins/io.github.quicknode.quicknode/`,
then run `omarchy-shell shell rescanPlugins` and `omarchy plugin enable io.github.quicknode.quicknode`.

## Setup

Expand All @@ -52,7 +52,7 @@ process environment rather than command-line arguments.
Settings live inline on the widget's entry in `~/.config/omarchy/shell.json`:

```json
{ "id": "io.github.sbarrau-qn.quicknode", "apiKey": "QN_...", "refreshMinutes": 15 }
{ "id": "io.github.quicknode.quicknode", "apiKey": "QN_...", "refreshMinutes": 15 }
```

| Key | Default | Meaning |
Expand All @@ -63,27 +63,27 @@ Settings live inline on the widget's entry in `~/.config/omarchy/shell.json`:
## Uninstall

```bash
omarchy plugin remove io.github.sbarrau-qn.quicknode
omarchy plugin remove io.github.quicknode.quicknode
```

This disables the widget and deletes the plugin folder, but it does not
touch `~/.config/omarchy/shell.json` — the widget's entry there, including
the stored API key, stays behind. Delete the `"id": "io.github.sbarrau-qn.quicknode"`
the stored API key, stays behind. Delete the `"id": "io.github.quicknode.quicknode"`
object from the bar layout by hand, and revoke the key in the
[QuickNode dashboard](https://dashboard.quicknode.com/api-keys) if you no
longer need it.

## Developing

Files under `~/.config/omarchy/plugins/io.github.sbarrau-qn.quicknode/` are watched, but in
Files under `~/.config/omarchy/plugins/io.github.quicknode.quicknode/` are watched, but in
practice edits to `Panel.qml` only took effect after `omarchy restart shell`
— the reload re-registers the widget without re-instantiating the nested
panel. Restart after each change to be sure you're looking at current code.

## IPC

```bash
omarchy-shell io.github.sbarrau-qn.quicknode toggle # open/close the popup
omarchy-shell io.github.sbarrau-qn.quicknode edit # open with the key editor focused
omarchy-shell io.github.sbarrau-qn.quicknode refresh # refetch usage and endpoints
omarchy-shell io.github.quicknode.quicknode toggle # open/close the popup
omarchy-shell io.github.quicknode.quicknode edit # open with the key editor focused
omarchy-shell io.github.quicknode.quicknode refresh # refetch usage and endpoints
```
4 changes: 2 additions & 2 deletions manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"schemaVersion": 1,
"id": "io.github.sbarrau-qn.quicknode",
"id": "io.github.quicknode.quicknode",
"name": "QuickNode",
"version": "1.0.0",
"author": "Sebastien Barrau",
"author": "Quicknode",
"license": "MIT",
"description": "QuickNode API credit usage and endpoint status from the Admin API",
"kinds": [
Expand Down