qgraphflow 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/plugins/marketplace.json +20 -0
- package/.claude-plugin/marketplace.json +17 -0
- package/.claude-plugin/plugin.json +13 -0
- package/.codex-plugin/plugin.json +26 -0
- package/.cursor-plugin/plugin.json +9 -0
- package/.qoder-plugin/plugin.json +9 -0
- package/LICENSE +21 -0
- package/README.md +262 -0
- package/THIRD_PARTY_NOTICES.md +190 -0
- package/bin/qgraphflow.mjs +17 -0
- package/docs/clients.de.md +83 -0
- package/docs/clients.es.md +83 -0
- package/docs/clients.ja.md +83 -0
- package/docs/clients.md +83 -0
- package/docs/clients.pt.md +83 -0
- package/docs/clients.ru.md +83 -0
- package/docs/clients.zh-CN.md +83 -0
- package/docs/readme/README.de.md +262 -0
- package/docs/readme/README.es.md +262 -0
- package/docs/readme/README.ja.md +262 -0
- package/docs/readme/README.pt.md +262 -0
- package/docs/readme/README.ru.md +262 -0
- package/docs/readme/README.zh-CN.md +264 -0
- package/examples/order-flow.graph.json +94 -0
- package/package.json +61 -0
- package/skills/q-flow/SKILL.md +69 -0
- package/skills/q-flow/agents/openai.yaml +5 -0
- package/skills/q-flow/assets/layout-dist/ELK-LICENSE.md +264 -0
- package/skills/q-flow/assets/layout-dist/worker.mjs +24 -0
- package/skills/q-flow/assets/viewer/package.json +22 -0
- package/skills/q-flow/assets/viewer/src/diagrams/architecture.js +43 -0
- package/skills/q-flow/assets/viewer/src/diagrams/card.js +21 -0
- package/skills/q-flow/assets/viewer/src/diagrams/class.js +52 -0
- package/skills/q-flow/assets/viewer/src/diagrams/dataflow.js +19 -0
- package/skills/q-flow/assets/viewer/src/diagrams/deployment.js +41 -0
- package/skills/q-flow/assets/viewer/src/diagrams/drawing.js +174 -0
- package/skills/q-flow/assets/viewer/src/diagrams/er.js +34 -0
- package/skills/q-flow/assets/viewer/src/diagrams/flowchart.js +37 -0
- package/skills/q-flow/assets/viewer/src/diagrams/registry.js +28 -0
- package/skills/q-flow/assets/viewer/src/diagrams/sequence.js +38 -0
- package/skills/q-flow/assets/viewer/src/diagrams/state.js +91 -0
- package/skills/q-flow/assets/viewer/src/diagrams/usecase.js +28 -0
- package/skills/q-flow/assets/viewer/src/edge-routing.js +596 -0
- package/skills/q-flow/assets/viewer/src/export-svg.js +90 -0
- package/skills/q-flow/assets/viewer/src/graph-validation.js +286 -0
- package/skills/q-flow/assets/viewer/src/i18n-messages.json +1314 -0
- package/skills/q-flow/assets/viewer/src/i18n.js +14 -0
- package/skills/q-flow/assets/viewer/src/layout-measure.js +55 -0
- package/skills/q-flow/assets/viewer/src/layout-quality.js +164 -0
- package/skills/q-flow/assets/viewer/src/layout-spacing.js +12 -0
- package/skills/q-flow/assets/viewer/src/node-svg.js +28 -0
- package/skills/q-flow/assets/viewer/src/radix-colors.js +47 -0
- package/skills/q-flow/assets/viewer/src/sequence-executions.js +140 -0
- package/skills/q-flow/assets/viewer/src/sequence-fragments.js +208 -0
- package/skills/q-flow/assets/viewer/src/session-graph.js +43 -0
- package/skills/q-flow/assets/viewer/src/text-layout.js +126 -0
- package/skills/q-flow/assets/viewer/src/visual-style.js +158 -0
- package/skills/q-flow/assets/viewer-dist/index.html +291 -0
- package/skills/q-flow/references/acceptance.md +11 -0
- package/skills/q-flow/references/evidence-sources.md +38 -0
- package/skills/q-flow/references/graph-common.md +54 -0
- package/skills/q-flow/references/graph-schema.md +214 -0
- package/skills/q-flow/references/guided-intake.md +100 -0
- package/skills/q-flow/references/types/architecture.md +41 -0
- package/skills/q-flow/references/types/class.md +40 -0
- package/skills/q-flow/references/types/dataflow.md +41 -0
- package/skills/q-flow/references/types/deployment.md +37 -0
- package/skills/q-flow/references/types/er.md +36 -0
- package/skills/q-flow/references/types/flowchart.md +47 -0
- package/skills/q-flow/references/types/sequence.md +74 -0
- package/skills/q-flow/references/types/state.md +44 -0
- package/skills/q-flow/references/types/usecase.md +39 -0
- package/skills/q-flow/references/viewer-development.md +258 -0
- package/skills/q-flow/references/visual-contract.md +54 -0
- package/skills/q-flow/scripts/compile-layout.mjs +565 -0
- package/skills/q-flow/scripts/compile-sequence.mjs +112 -0
- package/skills/q-flow/scripts/generate-viewer.mjs +126 -0
- package/skills/q-flow/scripts/validate-graph.mjs +278 -0
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Installationsanleitung
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[Zurück zur README](readme/README.de.md)
|
|
6
|
+
|
|
7
|
+
Qoder Desktop kann das Plugin aus dem Marketplace installieren, Claude Code direkt von GitHub (siehe die jeweiligen Abschnitte unten). In beiden Fällen entfällt Schritt 1. Für eine lokale Installation lade zuerst den QGraphFlow-Quellcode herunter und erstelle das Laufzeitpaket.
|
|
8
|
+
|
|
9
|
+
Du benötigst Node.js 22 oder neuer und einen Client mit eingerichtetem Modellzugriff. Zum Bauen aus dem Quellcode werden außerdem Git, npm, `tar`, `zip` und `unzip` benötigt.
|
|
10
|
+
|
|
11
|
+
## Schnellinstallation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Installiert den Skill `q-flow` für Claude Code, Codex, Cursor und Qoder (getestet mit `skills` 1.7.0) und fragt, in welche Clients installiert werden soll. Für die Installation als Plugin den folgenden Schritten folgen.
|
|
18
|
+
|
|
19
|
+
## 1. Für die lokale Installation herunterladen und bauen
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Wenn der QGraphFlow-Quellcode bereits vorliegt, überspringe das Klonen und wechsle in dessen Stammverzeichnis. Passe den ZIP-Dateinamen an die Version in der `package.json` von QGraphFlow an. Verwende neue Ausgabe- und Entpackverzeichnisse, ohne vorhandene Dateien zu überschreiben. Git lädt nur bereits gepushten Code herunter, keine lokalen Änderungen ohne Commit.
|
|
29
|
+
|
|
30
|
+
## 2. Im Client installieren
|
|
31
|
+
|
|
32
|
+
Führe die folgenden Befehle im Stammverzeichnis des QGraphFlow-Quellcodes aus, nicht im Verzeichnis deines eigenen Anwendungsprojekts. Sie installieren das vollständige Laufzeitpaket aus dem dortigen Unterverzeichnis `dist/runtime`.
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Hier registriert `marketplace add` nur eine lokale Installationsquelle; eine Veröffentlichung im öffentlichen Marktplatz ist nicht erforderlich. Siehe die [offizielle OpenAI-Dokumentation](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli).
|
|
42
|
+
|
|
43
|
+
Starte eine neue Sitzung, gib `$` ein und wähle `qgraphflow:q-flow` aus (verwende den tatsächlich im Client angezeigten Namen).
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
Direkt von GitHub installieren, ohne Schritt 1:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Oder aus dem in Schritt 1 erstellten Laufzeitpaket:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Starte eine neue Sitzung und gib `/q-flow` (oder den vollständigen Namen `/qgraphflow:q-flow`) ein.
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Starte eine neue Sitzung und wähle `q-flow` aus.
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**Empfohlen:** Öffne **Settings → Plugins → Marketplace**, suche nach **代码图谱可视化** oder **qgraphflow** und installiere das Plugin. Starte eine neue Sitzung und wähle `q-flow`. Ein ZIP-Download oder ein Build aus dem Quellcode ist nicht erforderlich.
|
|
74
|
+
|
|
75
|
+
Für eine lokale Installation führe zuerst Schritt 1 aus. Öffne dann **Settings → Plugins → Custom → Import** und importiere das vollständige Verzeichnis `dist/runtime`. Lade den Client neu und wähle `q-flow`.
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Kopiere den gesamten Inhalt von `dist/runtime`, einschließlich versteckter Dateien, nach `~/.cursor/plugins/local/qgraphflow/`. Sichere ein vorhandenes Verzeichnis zuerst; vermische keine alten und neuen Dateien.
|
|
80
|
+
|
|
81
|
+
Prüfe, ob das Manifest unter `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json` liegt. Lade das Fenster neu und wähle unter Customize → Plugins / Skills den Skill `q-flow` aus.
|
|
82
|
+
|
|
83
|
+
Diese lokale Methode wurde mit Cursor 3.19.13 getestet. Prüfe bei anderen Versionen, ob Plugin und Skill angezeigt werden.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Guía de instalación
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[Volver al README](readme/README.es.md)
|
|
6
|
+
|
|
7
|
+
Qoder Desktop permite instalar el complemento desde su Marketplace, y Claude Code directamente desde GitHub (consulta sus secciones más abajo). En ambos casos puedes omitir el paso 1. Para una instalación local, primero descarga el código fuente de QGraphFlow y genera el paquete de ejecución.
|
|
8
|
+
|
|
9
|
+
Necesitas Node.js 22 o posterior y un cliente con acceso al modelo configurado. Para compilar desde el código fuente también necesitas Git, npm, `tar`, `zip` y `unzip`.
|
|
10
|
+
|
|
11
|
+
## Instalación rápida
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Instala la habilidad `q-flow` en Claude Code, Codex, Cursor y Qoder (probado con `skills` 1.7.0) y pregunta en qué clientes instalar. Para instalar el complemento, sigue los pasos siguientes.
|
|
18
|
+
|
|
19
|
+
## 1. Descargar y generar el paquete para la instalación local
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Si ya tienes el código fuente de QGraphFlow, omite la clonación y entra en su directorio raíz. Ajusta el nombre del ZIP a la versión del `package.json` de QGraphFlow. Usa directorios nuevos para generar y extraer el paquete, sin sobrescribir archivos existentes. Git solo descarga el código enviado al repositorio, no los cambios locales sin commit.
|
|
29
|
+
|
|
30
|
+
## 2. Instalar en el cliente
|
|
31
|
+
|
|
32
|
+
Ejecuta los siguientes comandos desde la raíz del código fuente de QGraphFlow, no desde el directorio de tu propio proyecto. Instalan el paquete completo de la subcarpeta `dist/runtime`.
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Aquí, `marketplace add` solo registra una fuente de instalación local; no requiere publicar el complemento en un marketplace público. Consulta la [documentación oficial de OpenAI](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli).
|
|
42
|
+
|
|
43
|
+
Inicia una sesión nueva, escribe `$` y selecciona `qgraphflow:q-flow` (usa el nombre que muestre tu cliente).
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
Instala directamente desde GitHub, sin el paso 1:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
O bien, desde el paquete de ejecución generado en el paso 1:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Inicia una sesión nueva y escribe `/q-flow` (o el nombre completo `/qgraphflow:q-flow`).
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Inicia una sesión nueva y selecciona `q-flow`.
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**Recomendado:** Abre **Settings → Plugins → Marketplace**, busca **代码图谱可视化** o **qgraphflow** e instala el complemento. Inicia una sesión nueva y selecciona `q-flow`. No necesitas descargar un ZIP ni compilar el código fuente.
|
|
74
|
+
|
|
75
|
+
Para una instalación local, completa primero el paso 1. Después abre **Settings → Plugins → Custom → Import** e importa el directorio completo `dist/runtime`. Recarga el cliente y selecciona `q-flow`.
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Copia todo el contenido de `dist/runtime`, incluidos los archivos ocultos, a `~/.cursor/plugins/local/qgraphflow/`. Si el directorio ya existe, haz una copia de seguridad antes; no mezcles archivos antiguos y nuevos.
|
|
80
|
+
|
|
81
|
+
Comprueba que el manifiesto esté en `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Recarga la ventana y selecciona `q-flow` en Customize → Plugins / Skills.
|
|
82
|
+
|
|
83
|
+
Este método local se probó en Cursor 3.19.13. En otras versiones, comprueba que aparezcan tanto el complemento como la habilidad.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# インストールガイド
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[README に戻る](readme/README.ja.md)
|
|
6
|
+
|
|
7
|
+
Qoder Desktop ではマーケットプレイスから、Claude Code では GitHub から直接インストールできます(下記の各項を参照)。どちらも手順 1 は不要です。ローカルインストールの場合は、先に QGraphFlow のソースコードをダウンロードして実行用パッケージを作成してください。
|
|
8
|
+
|
|
9
|
+
Node.js 22 以降と、モデルへのアクセスを設定済みのクライアントが必要です。ソースからビルドする場合は、Git、npm、`tar`、`zip`、`unzip` も必要です。
|
|
10
|
+
|
|
11
|
+
## クイックインストール
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Claude Code、Codex、Cursor、Qoder にスキル `q-flow` を導入します(`skills` 1.7.0 で実測済み)。導入先のクライアントを尋ねられます。プラグインとして導入する場合は、次の手順に従ってください。
|
|
18
|
+
|
|
19
|
+
## 1. ローカルインストール用のダウンロードとパッケージ作成
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
QGraphFlow のソースコードが手元にある場合はクローンを省略し、そのルートディレクトリに移動してください。ZIP 名は QGraphFlow の `package.json` のバージョンに合わせます。出力先と展開先には新しいディレクトリを使い、既存ファイルを上書きしないでください。Git で取得できるのはプッシュ済みのコードのみで、未コミットのローカル変更は含まれません。
|
|
29
|
+
|
|
30
|
+
## 2. クライアントにインストール
|
|
31
|
+
|
|
32
|
+
以下のコマンドは、自分の業務プロジェクトではなく、QGraphFlow のソースコードのルートディレクトリで実行します。その配下の `dist/runtime` にある完全な実行用パッケージをインストールします。
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
ここでの `marketplace add` はローカルのインストール元を登録するだけで、公開マーケットプレイスへの掲載は不要です。[OpenAI 公式ドキュメント](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli)を参照してください。
|
|
42
|
+
|
|
43
|
+
新しいセッションを開始し、`$` を入力して `qgraphflow:q-flow` を選択します(クライアントに実際に表示される名前を使用してください)。
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
手順 1 を省略して GitHub から直接インストールします:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
または、手順 1 で作成した実行用パッケージを使います:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
新しいセッションを開始し、`/q-flow`(または完全名 `/qgraphflow:q-flow`)を入力します。
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
新しいセッションを開始し、`q-flow` を選択します。
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**推奨:** **Settings → Plugins → Marketplace** を開き、**代码图谱可视化** または **qgraphflow** を検索してインストールします。新しいセッションを開始し、`q-flow` を選択します。ZIP のダウンロードやソースのビルドは不要です。
|
|
74
|
+
|
|
75
|
+
ローカルインストールの場合は手順 1 を完了し、**Settings → Plugins → Custom → Import** を開いて、`dist/runtime` ディレクトリ全体をインポートします。再読み込み後、`q-flow` を選択します。
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
`dist/runtime` の内容を隠しファイルも含めてすべて `~/.cursor/plugins/local/qgraphflow/` にコピーします。既存のディレクトリがある場合は先にバックアップし、新旧のファイルを混在させないでください。
|
|
80
|
+
|
|
81
|
+
マニフェストが `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json` にあることを確認します。ウィンドウを再読み込みし、Customize → Plugins / Skills で `q-flow` を選択します。
|
|
82
|
+
|
|
83
|
+
このローカル方式は Cursor 3.19.13 で検証済みです。他のバージョンでは、プラグインとスキルが表示されることを確認してください。
|
package/docs/clients.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Installation guide
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[Back to README](../README.md)
|
|
6
|
+
|
|
7
|
+
Qoder Desktop can install the plugin from its marketplace, and Claude Code can install directly from GitHub (see their sections below). Both can skip step 1. For local installation, download the QGraphFlow source and build the runtime package first.
|
|
8
|
+
|
|
9
|
+
You need Node.js 22 or later and a client with model access configured. Building from source also requires Git, npm, `tar`, `zip` and `unzip`.
|
|
10
|
+
|
|
11
|
+
## Quick install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Installs the skill as `q-flow` for Claude Code, Codex, Cursor and Qoder (tested with `skills` 1.7.0); it asks which clients to install to. To install the plugin instead, follow the steps below.
|
|
18
|
+
|
|
19
|
+
## 1. Download and build for local installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
If you already have the QGraphFlow source, skip cloning and enter its root directory. Match the ZIP filename to the version in QGraphFlow's `package.json`. Use new build and extraction directories; do not overwrite existing files. Git downloads contain only pushed code, not uncommitted local changes.
|
|
29
|
+
|
|
30
|
+
## 2. Install in your client
|
|
31
|
+
|
|
32
|
+
Run the commands below from the QGraphFlow source root, not your application's project directory. They install the complete runtime package in that directory's `dist/runtime` folder.
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Here, `marketplace add` only registers a local installation source; no public marketplace listing is required. See the [official OpenAI documentation](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli).
|
|
42
|
+
|
|
43
|
+
Start a new session, type `$`, and select `qgraphflow:q-flow` (use the name actually shown by your client).
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
Install directly from GitHub without step 1:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Or, from the runtime package built in step 1:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Start a new session and enter `/q-flow` (or the fully qualified `/qgraphflow:q-flow`).
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Start a new session and select `q-flow`.
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**Recommended:** Open **Settings → Plugins → Marketplace**, search for **代码图谱可视化** or **qgraphflow**, and install the plugin. Start a new session and select `q-flow`. No ZIP download or source build is required.
|
|
74
|
+
|
|
75
|
+
For local installation, complete step 1, then open **Settings → Plugins → Custom → Import** and import the complete `dist/runtime` directory. Reload, then select `q-flow`.
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Copy everything inside `dist/runtime`, including hidden files, to `~/.cursor/plugins/local/qgraphflow/`. Back up any existing directory first; do not mix old and new files.
|
|
80
|
+
|
|
81
|
+
Confirm the manifest is at `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Reload the window, then select `q-flow` under Customize → Plugins / Skills.
|
|
82
|
+
|
|
83
|
+
This local method was tested with Cursor 3.19.13. On other versions, confirm that both the plugin and skill appear.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Guia de instalação
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[Voltar ao README](readme/README.pt.md)
|
|
6
|
+
|
|
7
|
+
O Qoder Desktop pode instalar o plugin pelo Marketplace, e o Claude Code diretamente do GitHub (veja as respectivas seções abaixo). Nos dois casos, você pode pular a etapa 1. Para uma instalação local, primeiro baixe o código-fonte do QGraphFlow e gere o pacote de execução.
|
|
8
|
+
|
|
9
|
+
Você precisa de Node.js 22 ou posterior e de um cliente com acesso ao modelo configurado. Para compilar a partir do código-fonte, também precisa de Git, npm, `tar`, `zip` e `unzip`.
|
|
10
|
+
|
|
11
|
+
## Instalação rápida
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Instala a habilidade `q-flow` no Claude Code, Codex, Cursor e Qoder (testado com `skills` 1.7.0) e pergunta em quais clientes instalar. Para instalar o plugin, siga as etapas abaixo.
|
|
18
|
+
|
|
19
|
+
## 1. Baixar e gerar o pacote para instalação local
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Se já tiver o código-fonte do QGraphFlow, pule a clonagem e entre no diretório raiz dele. Ajuste o nome do ZIP à versão no `package.json` do QGraphFlow. Use novos diretórios para gerar e extrair o pacote, sem sobrescrever arquivos existentes. O Git baixa apenas o código enviado ao repositório, não as alterações locais sem commit.
|
|
29
|
+
|
|
30
|
+
## 2. Instalar no cliente
|
|
31
|
+
|
|
32
|
+
Execute os comandos abaixo na raiz do código-fonte do QGraphFlow, não no diretório do seu próprio projeto. Eles instalam o pacote completo da subpasta `dist/runtime`.
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Aqui, `marketplace add` apenas registra uma fonte de instalação local; não exige publicação em um marketplace público. Consulte a [documentação oficial da OpenAI](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli).
|
|
42
|
+
|
|
43
|
+
Inicie uma nova sessão, digite `$` e selecione `qgraphflow:q-flow` (use o nome exibido pelo seu cliente).
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
Instale diretamente do GitHub, sem o passo 1:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Ou a partir do pacote de execução gerado no passo 1:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Inicie uma nova sessão e digite `/q-flow` (ou o nome completo `/qgraphflow:q-flow`).
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Inicie uma nova sessão e selecione `q-flow`.
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**Recomendado:** Abra **Settings → Plugins → Marketplace**, pesquise **代码图谱可视化** ou **qgraphflow** e instale o plugin. Inicie uma nova sessão e selecione `q-flow`. Não é necessário baixar um ZIP nem compilar o código-fonte.
|
|
74
|
+
|
|
75
|
+
Para uma instalação local, conclua primeiro a etapa 1. Depois, abra **Settings → Plugins → Custom → Import** e importe o diretório completo `dist/runtime`. Recarregue o cliente e selecione `q-flow`.
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Copie todo o conteúdo de `dist/runtime`, incluindo arquivos ocultos, para `~/.cursor/plugins/local/qgraphflow/`. Se o diretório já existir, faça um backup antes; não misture arquivos antigos e novos.
|
|
80
|
+
|
|
81
|
+
Confirme que o manifesto está em `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Recarregue a janela e selecione `q-flow` em Customize → Plugins / Skills.
|
|
82
|
+
|
|
83
|
+
Esse método local foi testado no Cursor 3.19.13. Em outras versões, confirme que o plugin e a habilidade aparecem.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Руководство по установке
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[Вернуться к README](readme/README.ru.md)
|
|
6
|
+
|
|
7
|
+
В Qoder Desktop плагин можно установить из Marketplace, а в Claude Code — напрямую с GitHub (см. соответствующие разделы ниже). В обоих случаях шаг 1 можно пропустить. Для локальной установки сначала скачайте исходный код QGraphFlow и соберите пакет для установки.
|
|
8
|
+
|
|
9
|
+
Нужны Node.js 22 или новее и клиент с настроенным доступом к модели. Для сборки из исходников также нужны Git, npm, `tar`, `zip` и `unzip`.
|
|
10
|
+
|
|
11
|
+
## Быстрая установка
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Устанавливает навык `q-flow` для Claude Code, Codex, Cursor и Qoder (проверено с `skills` 1.7.0) и спрашивает, в какие клиенты устанавливать. Чтобы установить плагин, выполните шаги ниже.
|
|
18
|
+
|
|
19
|
+
## 1. Скачать и собрать для локальной установки
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Если исходный код QGraphFlow уже скачан, пропустите клонирование и перейдите в его корневой каталог. Имя ZIP должно соответствовать версии в `package.json` проекта QGraphFlow. Используйте новые каталоги для сборки и распаковки, не перезаписывая старые файлы. Git скачивает только отправленный в репозиторий код, без незакоммиченных локальных изменений.
|
|
29
|
+
|
|
30
|
+
## 2. Установить в клиент
|
|
31
|
+
|
|
32
|
+
Выполняйте команды ниже из корневого каталога исходного кода QGraphFlow, а не из каталога вашего приложения. Они устанавливают полный пакет из вложенного каталога `dist/runtime`.
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Здесь `marketplace add` только регистрирует локальный источник установки; публикация в маркетплейсе не требуется. См. [официальную документацию OpenAI](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli).
|
|
42
|
+
|
|
43
|
+
Начните новый сеанс, введите `$` и выберите `qgraphflow:q-flow` (используйте имя, которое показывает ваш клиент).
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
Установите напрямую с GitHub, пропустив шаг 1:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Или из пакета, собранного на шаге 1:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Начните новый сеанс и введите `/q-flow` (или полное имя `/qgraphflow:q-flow`).
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Начните новый сеанс и выберите `q-flow`.
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**Рекомендуется:** Откройте **Settings → Plugins → Marketplace**, найдите **代码图谱可视化** или **qgraphflow** и установите плагин. Начните новый сеанс и выберите `q-flow`. Скачивать ZIP или собирать исходный код не требуется.
|
|
74
|
+
|
|
75
|
+
Для локальной установки выполните шаг 1, затем откройте **Settings → Plugins → Custom → Import** и импортируйте весь каталог `dist/runtime`. Перезагрузите клиент и выберите `q-flow`.
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
Скопируйте всё содержимое `dist/runtime`, включая скрытые файлы, в `~/.cursor/plugins/local/qgraphflow/`. Если каталог уже существует, сначала сделайте резервную копию; не смешивайте старые и новые файлы.
|
|
80
|
+
|
|
81
|
+
Убедитесь, что манифест находится по адресу `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Перезагрузите окно и выберите `q-flow` в Customize → Plugins / Skills.
|
|
82
|
+
|
|
83
|
+
Этот способ локальной установки проверялся в Cursor 3.19.13. В других версиях убедитесь, что плагин и навык отображаются.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# 安装指南
|
|
2
|
+
|
|
3
|
+
[English](clients.md) · [中文](clients.zh-CN.md) · [Русский](clients.ru.md) · [Português](clients.pt.md) · [日本語](clients.ja.md) · [Deutsch](clients.de.md) · [Español](clients.es.md)
|
|
4
|
+
|
|
5
|
+
[返回 README](readme/README.zh-CN.md)
|
|
6
|
+
|
|
7
|
+
Qoder Desktop 可从插件商城安装,Claude Code 可直接从 GitHub 安装(见下方对应小节),两者均可跳过第 1 步。采用本地安装时,先下载 QGraphFlow 源码并构建运行包。
|
|
8
|
+
|
|
9
|
+
准备 Node.js 22 及以上版本,以及已配置好模型访问的客户端。从源码构建还需 Git、npm、`tar`、`zip` 和 `unzip`。
|
|
10
|
+
|
|
11
|
+
## 快速安装
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx skills add supermax92/qgraphflow
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
为 Claude Code、Codex、Cursor 和 Qoder 安装技能 `q-flow`(已用 `skills` 1.7.0 实测),命令会询问装到哪些客户端。如需以插件方式安装,按以下步骤操作。
|
|
18
|
+
|
|
19
|
+
## 1. 下载并构建(用于本地安装)
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/supermax92/qgraphflow.git
|
|
23
|
+
cd qgraphflow
|
|
24
|
+
npm run package
|
|
25
|
+
unzip -q dist/qgraphflow-0.0.6.zip -d dist/runtime
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
已有 QGraphFlow 源码可跳过克隆,并进入其根目录。ZIP 文件名以 QGraphFlow 的 `package.json` 版本为准;使用新的输出和解压目录,不覆盖旧文件。Git 下载只包含已推送的代码,不包含尚未提交的本地修改。
|
|
29
|
+
|
|
30
|
+
## 2. 选择客户端安装
|
|
31
|
+
|
|
32
|
+
以下命令均在 QGraphFlow 源码根目录执行,不是你的业务项目目录。安装的是该目录下 `dist/runtime` 中的完整运行包。
|
|
33
|
+
|
|
34
|
+
### Codex App / CLI
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
codex plugin marketplace add ./dist/runtime
|
|
38
|
+
codex plugin add qgraphflow@supermax92
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
这里的 `marketplace add` 只注册本地安装源,不要求公开市场上架。参见 [OpenAI 官方文档](https://developers.openai.com/plugins/build/plugins#add-a-marketplace-from-the-cli)。
|
|
42
|
+
|
|
43
|
+
新建会话,输入 `$`,选择 `qgraphflow:q-flow`(以客户端实际显示的名称为准)。
|
|
44
|
+
|
|
45
|
+
### Claude Code
|
|
46
|
+
|
|
47
|
+
直接从 GitHub 安装,无需执行第 1 步:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
或使用第 1 步构建的运行包:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
claude plugin marketplace add ./dist/runtime
|
|
58
|
+
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
新建会话,输入 `/q-flow`(或完整名称 `/qgraphflow:q-flow`)。
|
|
62
|
+
|
|
63
|
+
### Qoder CLI
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qodercli plugins install ./dist/runtime
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
新建会话,选择 `q-flow`。
|
|
70
|
+
|
|
71
|
+
### Qoder Desktop
|
|
72
|
+
|
|
73
|
+
**推荐:**打开 **Settings → Plugins → Marketplace**,搜索 **代码图谱可视化** 或 **qgraphflow**,安装插件。新建会话,选择 `q-flow`。无需下载 ZIP 或构建源码。
|
|
74
|
+
|
|
75
|
+
如需本地安装,先完成第 1 步,再打开 **Settings → Plugins → Custom → Import**,导入完整的 `dist/runtime` 目录;重新加载后选择 `q-flow`。
|
|
76
|
+
|
|
77
|
+
### Cursor
|
|
78
|
+
|
|
79
|
+
将 `dist/runtime` 内的全部内容(含隐藏文件)复制到 `~/.cursor/plugins/local/qgraphflow/`。已有目录先备份,勿混合新旧文件。
|
|
80
|
+
|
|
81
|
+
确认清单位于 `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`,重新加载窗口,在 Customize → Plugins / Skills 中选择 `q-flow`。
|
|
82
|
+
|
|
83
|
+
此本地方式曾在 Cursor 3.19.13 验证;其他版本请确认插件和技能已显示。
|