qgraphflow 0.0.6 → 0.0.7

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.
Files changed (89) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/.codex-plugin/plugin.json +2 -2
  4. package/.cursor-plugin/plugin.json +1 -1
  5. package/.qoder-plugin/plugin.json +1 -1
  6. package/README.md +119 -70
  7. package/docs/clients.de.md +15 -24
  8. package/docs/clients.es.md +15 -24
  9. package/docs/clients.ja.md +15 -24
  10. package/docs/clients.md +15 -24
  11. package/docs/clients.pt.md +15 -24
  12. package/docs/clients.ru.md +15 -24
  13. package/docs/clients.zh-CN.md +15 -24
  14. package/docs/readme/README.de.md +120 -71
  15. package/docs/readme/README.es.md +120 -71
  16. package/docs/readme/README.ja.md +120 -71
  17. package/docs/readme/README.pt.md +120 -71
  18. package/docs/readme/README.ru.md +120 -71
  19. package/docs/readme/README.zh-CN.md +106 -59
  20. package/examples/jeepay/README.md +23 -0
  21. package/examples/jeepay/capabilities.graph.json +270 -0
  22. package/examples/jeepay/class.graph.json +237 -0
  23. package/examples/jeepay/collection.graph.json +3057 -0
  24. package/examples/jeepay/dataflow.graph.json +212 -0
  25. package/examples/jeepay/deployment.graph.json +222 -0
  26. package/examples/jeepay/engineering.graph.json +277 -0
  27. package/examples/jeepay/er.graph.json +482 -0
  28. package/examples/jeepay/flowchart.graph.json +312 -0
  29. package/examples/jeepay/relations.graph.json +289 -0
  30. package/examples/jeepay/sequence.graph.json +355 -0
  31. package/examples/jeepay/source.json +95 -0
  32. package/examples/jeepay/state.graph.json +175 -0
  33. package/examples/jeepay/usecase.graph.json +222 -0
  34. package/package.json +14 -3
  35. package/skills/q-flow/SKILL.md +28 -20
  36. package/skills/q-flow/agents/openai.yaml +1 -1
  37. package/skills/q-flow/assets/viewer/package.json +1 -1
  38. package/skills/q-flow/assets/viewer/src/architecture-overview-theme.js +22 -0
  39. package/skills/q-flow/assets/viewer/src/architecture-overview.js +340 -0
  40. package/skills/q-flow/assets/viewer/src/diagrams/architecture.js +8 -5
  41. package/skills/q-flow/assets/viewer/src/diagrams/card.js +35 -17
  42. package/skills/q-flow/assets/viewer/src/diagrams/deployment.js +7 -5
  43. package/skills/q-flow/assets/viewer/src/diagrams/drawing.js +5 -2
  44. package/skills/q-flow/assets/viewer/src/diagrams/registry.js +10 -0
  45. package/skills/q-flow/assets/viewer/src/diagrams/sequence.js +13 -7
  46. package/skills/q-flow/assets/viewer/src/edge-routing.js +43 -22
  47. package/skills/q-flow/assets/viewer/src/export-svg.js +27 -5
  48. package/skills/q-flow/assets/viewer/src/graph-validation.js +72 -15
  49. package/skills/q-flow/assets/viewer/src/i18n-messages.json +184 -8
  50. package/skills/q-flow/assets/viewer/src/layout-compaction.js +123 -0
  51. package/skills/q-flow/assets/viewer/src/layout-measure.js +14 -8
  52. package/skills/q-flow/assets/viewer/src/layout-policy.js +6 -0
  53. package/skills/q-flow/assets/viewer/src/layout-quality.js +61 -15
  54. package/skills/q-flow/assets/viewer/src/layout-refinement.js +271 -0
  55. package/skills/q-flow/assets/viewer/src/layout-semantics.js +8 -0
  56. package/skills/q-flow/assets/viewer/src/layout-spacing.js +23 -4
  57. package/skills/q-flow/assets/viewer/src/layout-templates.js +298 -0
  58. package/skills/q-flow/assets/viewer/src/node-svg.js +1 -1
  59. package/skills/q-flow/assets/viewer/src/orthogonal-routing.js +475 -0
  60. package/skills/q-flow/assets/viewer/src/presentation-graph.js +31 -0
  61. package/skills/q-flow/assets/viewer/src/route-clearance.js +144 -0
  62. package/skills/q-flow/assets/viewer/src/sequence-executions.js +22 -0
  63. package/skills/q-flow/assets/viewer/src/sequence-fragments.js +20 -2
  64. package/skills/q-flow/assets/viewer/src/session-graph.js +46 -3
  65. package/skills/q-flow/assets/viewer/src/text-layout.js +33 -6
  66. package/skills/q-flow/assets/viewer/src/view-identity.js +26 -0
  67. package/skills/q-flow/assets/viewer/src/visual-style.js +13 -5
  68. package/skills/q-flow/assets/viewer-dist/index.html +30 -28
  69. package/skills/q-flow/references/evidence-sources.md +7 -5
  70. package/skills/q-flow/references/graph-common.md +34 -34
  71. package/skills/q-flow/references/graph-schema.md +28 -7
  72. package/skills/q-flow/references/guided-intake.md +51 -71
  73. package/skills/q-flow/references/layout-routing.md +47 -0
  74. package/skills/q-flow/references/types/architecture.md +42 -22
  75. package/skills/q-flow/references/types/class.md +9 -2
  76. package/skills/q-flow/references/types/dataflow.md +11 -4
  77. package/skills/q-flow/references/types/deployment.md +11 -3
  78. package/skills/q-flow/references/types/er.md +8 -1
  79. package/skills/q-flow/references/types/flowchart.md +12 -5
  80. package/skills/q-flow/references/types/sequence.md +20 -16
  81. package/skills/q-flow/references/types/state.md +10 -3
  82. package/skills/q-flow/references/types/usecase.md +6 -0
  83. package/skills/q-flow/references/viewer-development.md +37 -24
  84. package/skills/q-flow/references/visual-contract.md +12 -6
  85. package/skills/q-flow/scripts/compile-layout.mjs +85 -102
  86. package/skills/q-flow/scripts/compile-sequence.mjs +4 -21
  87. package/skills/q-flow/scripts/generate-viewer.mjs +18 -9
  88. package/skills/q-flow/scripts/validate-graph.mjs +38 -21
  89. package/examples/order-flow.graph.json +0 -94
@@ -4,9 +4,9 @@
4
4
 
5
5
  [README に戻る](readme/README.ja.md)
6
6
 
7
- Qoder Desktop ではマーケットプレイスから、Claude Code では GitHub から直接インストールできます(下記の各項を参照)。どちらも手順 1 は不要です。ローカルインストールの場合は、先に QGraphFlow のソースコードをダウンロードして実行用パッケージを作成してください。
7
+ Qoder Desktop ではマーケットプレイスからインストールでき、手順 1 は不要です(下記の該当項を参照)。その他のクライアントでは、npmjs.com から取得したプラグインパッケージをインストールします。
8
8
 
9
- Node.js 22 以降と、モデルへのアクセスを設定済みのクライアントが必要です。ソースからビルドする場合は、Git、npm、`tar`、`zip`、`unzip` も必要です。
9
+ Node.js 22 以降(npm を含む)と、モデルへのアクセスを設定済みのクライアントが必要です。
10
10
 
11
11
  ## クイックインストール
12
12
 
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
16
16
 
17
17
  Claude Code、Codex、Cursor、Qoder にスキル `q-flow` を導入します(`skills` 1.7.0 で実測済み)。導入先のクライアントを尋ねられます。プラグインとして導入する場合は、次の手順に従ってください。
18
18
 
19
- ## 1. ローカルインストール用のダウンロードとパッケージ作成
19
+ ## 1. npm からプラグインをダウンロード
20
20
 
21
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
22
+ mkdir qgraphflow-install
23
+ cd qgraphflow-install
24
+ npm install qgraphflow --ignore-scripts
25
+ cd node_modules/qgraphflow
26
26
  ```
27
27
 
28
- QGraphFlow のソースコードが手元にある場合はクローンを省略し、そのルートディレクトリに移動してください。ZIP 名は QGraphFlow の `package.json` のバージョンに合わせます。出力先と展開先には新しいディレクトリを使い、既存ファイルを上書きしないでください。Git で取得できるのはプッシュ済みのコードのみで、未コミットのローカル変更は含まれません。
28
+ ディレクトリは業務プロジェクトの外に作成します。アカウント、ログイン、トークンは不要です。これでプラグインのルートディレクトリに移動できました。npm でダウンロードしてもクライアントへのインストールは自動では行われないため、手順 2 に進んでください。未リリースのコードをインストールする場合は、[ソースからのビルド手順](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally)を参照してください。
29
29
 
30
30
  ## 2. クライアントにインストール
31
31
 
32
- 以下のコマンドは、自分の業務プロジェクトではなく、QGraphFlow のソースコードのルートディレクトリで実行します。その配下の `dist/runtime` にある完全な実行用パッケージをインストールします。
32
+ 以下のコマンドは、自分の業務プロジェクトではなく、手順 1 で移動したプラグインのルートディレクトリ(`qgraphflow-install/node_modules/qgraphflow`)で実行します。
33
33
 
34
34
  ### Codex App / CLI
35
35
 
36
36
  ```bash
37
- codex plugin marketplace add ./dist/runtime
37
+ codex plugin marketplace add .
38
38
  codex plugin add qgraphflow@supermax92
39
39
  ```
40
40
 
@@ -44,17 +44,8 @@ codex plugin add qgraphflow@supermax92
44
44
 
45
45
  ### Claude Code
46
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
47
  ```bash
57
- claude plugin marketplace add ./dist/runtime
48
+ claude plugin marketplace add ./
58
49
  claude plugin install qgraphflow@supermax92 --scope user
59
50
  ```
60
51
 
@@ -63,20 +54,20 @@ claude plugin install qgraphflow@supermax92 --scope user
63
54
  ### Qoder CLI
64
55
 
65
56
  ```bash
66
- qodercli plugins install ./dist/runtime
57
+ qodercli plugins install .
67
58
  ```
68
59
 
69
60
  新しいセッションを開始し、`q-flow` を選択します。
70
61
 
71
62
  ### Qoder Desktop
72
63
 
73
- **推奨:** **Settings → Plugins → Marketplace** を開き、**代码图谱可视化** または **qgraphflow** を検索してインストールします。新しいセッションを開始し、`q-flow` を選択します。ZIP のダウンロードやソースのビルドは不要です。
64
+ **推奨:** **Settings → Plugins → Marketplace** を開き、**QGraphFlow** または **代码图谱可视化** を検索してインストールします。新しいセッションを開始し、`q-flow` を選択します。
74
65
 
75
- ローカルインストールの場合は手順 1 を完了し、**Settings → Plugins → Custom → Import** を開いて、`dist/runtime` ディレクトリ全体をインポートします。再読み込み後、`q-flow` を選択します。
66
+ ローカルインストールの場合は手順 1 を完了し、**Settings → Plugins → Custom → Import** を開いて、プラグインのルートディレクトリ全体をインポートします。再読み込み後、`q-flow` を選択します。
76
67
 
77
68
  ### Cursor
78
69
 
79
- `dist/runtime` の内容を隠しファイルも含めてすべて `~/.cursor/plugins/local/qgraphflow/` にコピーします。既存のディレクトリがある場合は先にバックアップし、新旧のファイルを混在させないでください。
70
+ プラグインのルートディレクトリの内容を隠しファイルも含めてすべて `~/.cursor/plugins/local/qgraphflow/` にコピーします。既存のディレクトリがある場合は先にバックアップし、新旧のファイルを混在させないでください。
80
71
 
81
72
  マニフェストが `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json` にあることを確認します。ウィンドウを再読み込みし、Customize → Plugins / Skills で `q-flow` を選択します。
82
73
 
package/docs/clients.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  [Back to README](../README.md)
6
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.
7
+ Qoder Desktop can install the plugin from its marketplace and skip step 1 (see its section below). The other clients install the plugin package from npmjs.com.
8
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`.
9
+ You need Node.js 22 or later (with npm) and a client with model access configured.
10
10
 
11
11
  ## Quick install
12
12
 
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
16
16
 
17
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
18
 
19
- ## 1. Download and build for local installation
19
+ ## 1. Download the plugin from npm
20
20
 
21
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
22
+ mkdir qgraphflow-install
23
+ cd qgraphflow-install
24
+ npm install qgraphflow --ignore-scripts
25
+ cd node_modules/qgraphflow
26
26
  ```
27
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.
28
+ Create the directory outside your application project; no account, login or token is needed. You are now in the plugin root. Downloading through npm does not install the plugin in your client; continue with step 2. To install code that is not yet released, see the [source build instructions](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
29
29
 
30
30
  ## 2. Install in your client
31
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.
32
+ Run the commands below from the plugin root entered in step 1 (`qgraphflow-install/node_modules/qgraphflow`), not your application's project directory.
33
33
 
34
34
  ### Codex App / CLI
35
35
 
36
36
  ```bash
37
- codex plugin marketplace add ./dist/runtime
37
+ codex plugin marketplace add .
38
38
  codex plugin add qgraphflow@supermax92
39
39
  ```
40
40
 
@@ -44,17 +44,8 @@ Start a new session, type `$`, and select `qgraphflow:q-flow` (use the name actu
44
44
 
45
45
  ### Claude Code
46
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
47
  ```bash
57
- claude plugin marketplace add ./dist/runtime
48
+ claude plugin marketplace add ./
58
49
  claude plugin install qgraphflow@supermax92 --scope user
59
50
  ```
60
51
 
@@ -63,20 +54,20 @@ Start a new session and enter `/q-flow` (or the fully qualified `/qgraphflow:q-f
63
54
  ### Qoder CLI
64
55
 
65
56
  ```bash
66
- qodercli plugins install ./dist/runtime
57
+ qodercli plugins install .
67
58
  ```
68
59
 
69
60
  Start a new session and select `q-flow`.
70
61
 
71
62
  ### Qoder Desktop
72
63
 
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.
64
+ **Recommended:** Open **Settings → Plugins → Marketplace**, search for **QGraphFlow** or **代码图谱可视化**, and install the plugin. Start a new session and select `q-flow`.
74
65
 
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`.
66
+ For local installation, complete step 1, then open **Settings → Plugins → Custom → Import** and import the complete plugin root directory. Reload, then select `q-flow`.
76
67
 
77
68
  ### Cursor
78
69
 
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.
70
+ Copy everything inside the plugin root, including hidden files, to `~/.cursor/plugins/local/qgraphflow/`. Back up any existing directory first; do not mix old and new files.
80
71
 
81
72
  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
73
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  [Voltar ao README](readme/README.pt.md)
6
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.
7
+ O Qoder Desktop pode instalar o plugin pelo Marketplace e pular a etapa 1 (veja a seção correspondente abaixo). Os demais clientes instalam o pacote do plugin obtido no npmjs.com.
8
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`.
9
+ Você precisa de Node.js 22 ou posterior (com npm) e de um cliente com acesso ao modelo configurado.
10
10
 
11
11
  ## Instalação rápida
12
12
 
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
16
16
 
17
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
18
 
19
- ## 1. Baixar e gerar o pacote para instalação local
19
+ ## 1. Baixar o plugin pelo npm
20
20
 
21
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
22
+ mkdir qgraphflow-install
23
+ cd qgraphflow-install
24
+ npm install qgraphflow --ignore-scripts
25
+ cd node_modules/qgraphflow
26
26
  ```
27
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.
28
+ Crie o diretório fora do projeto da sua aplicação; não é preciso conta, login nem token. Agora você está na raiz do plugin. Baixar pelo npm não instala o plugin no cliente; continue na etapa 2. Para instalar código ainda não lançado, consulte as [instruções de compilação a partir do código-fonte](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
29
29
 
30
30
  ## 2. Instalar no cliente
31
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`.
32
+ Execute os comandos abaixo na raiz do plugin aberta na etapa 1 (`qgraphflow-install/node_modules/qgraphflow`), não no diretório do seu próprio projeto.
33
33
 
34
34
  ### Codex App / CLI
35
35
 
36
36
  ```bash
37
- codex plugin marketplace add ./dist/runtime
37
+ codex plugin marketplace add .
38
38
  codex plugin add qgraphflow@supermax92
39
39
  ```
40
40
 
@@ -44,17 +44,8 @@ Inicie uma nova sessão, digite `$` e selecione `qgraphflow:q-flow` (use o nome
44
44
 
45
45
  ### Claude Code
46
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
47
  ```bash
57
- claude plugin marketplace add ./dist/runtime
48
+ claude plugin marketplace add ./
58
49
  claude plugin install qgraphflow@supermax92 --scope user
59
50
  ```
60
51
 
@@ -63,20 +54,20 @@ Inicie uma nova sessão e digite `/q-flow` (ou o nome completo `/qgraphflow:q-fl
63
54
  ### Qoder CLI
64
55
 
65
56
  ```bash
66
- qodercli plugins install ./dist/runtime
57
+ qodercli plugins install .
67
58
  ```
68
59
 
69
60
  Inicie uma nova sessão e selecione `q-flow`.
70
61
 
71
62
  ### Qoder Desktop
72
63
 
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.
64
+ **Recomendado:** Abra **Settings → Plugins → Marketplace**, pesquise **QGraphFlow** ou **代码图谱可视化** e instale o plugin. Inicie uma nova sessão e selecione `q-flow`.
74
65
 
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`.
66
+ Para uma instalação local, conclua primeiro a etapa 1. Depois, abra **Settings → Plugins → Custom → Import** e importe o diretório raiz completo do plugin. Recarregue o cliente e selecione `q-flow`.
76
67
 
77
68
  ### Cursor
78
69
 
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.
70
+ Copie todo o conteúdo da raiz do plugin, 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
71
 
81
72
  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
73
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  [Вернуться к README](readme/README.ru.md)
6
6
 
7
- В Qoder Desktop плагин можно установить из Marketplace, а в Claude Code — напрямую с GitHub (см. соответствующие разделы ниже). В обоих случаях шаг 1 можно пропустить. Для локальной установки сначала скачайте исходный код QGraphFlow и соберите пакет для установки.
7
+ В Qoder Desktop плагин можно установить из Marketplace и пропустить шаг 1 (см. соответствующий раздел ниже). Остальные клиенты устанавливают пакет плагина с npmjs.com.
8
8
 
9
- Нужны Node.js 22 или новее и клиент с настроенным доступом к модели. Для сборки из исходников также нужны Git, npm, `tar`, `zip` и `unzip`.
9
+ Нужны Node.js 22 или новее (с npm) и клиент с настроенным доступом к модели.
10
10
 
11
11
  ## Быстрая установка
12
12
 
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
16
16
 
17
17
  Устанавливает навык `q-flow` для Claude Code, Codex, Cursor и Qoder (проверено с `skills` 1.7.0) и спрашивает, в какие клиенты устанавливать. Чтобы установить плагин, выполните шаги ниже.
18
18
 
19
- ## 1. Скачать и собрать для локальной установки
19
+ ## 1. Скачать плагин из npm
20
20
 
21
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
22
+ mkdir qgraphflow-install
23
+ cd qgraphflow-install
24
+ npm install qgraphflow --ignore-scripts
25
+ cd node_modules/qgraphflow
26
26
  ```
27
27
 
28
- Если исходный код QGraphFlow уже скачан, пропустите клонирование и перейдите в его корневой каталог. Имя ZIP должно соответствовать версии в `package.json` проекта QGraphFlow. Используйте новые каталоги для сборки и распаковки, не перезаписывая старые файлы. Git скачивает только отправленный в репозиторий код, без незакоммиченных локальных изменений.
28
+ Создайте каталог вне своего рабочего проекта; учётная запись, вход и токен не нужны. Теперь вы в корневом каталоге плагина. Загрузка через npm не устанавливает плагин в клиент — перейдите к шагу 2. Чтобы установить ещё не выпущенный код, см. [инструкции по сборке из исходников](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
29
29
 
30
30
  ## 2. Установить в клиент
31
31
 
32
- Выполняйте команды ниже из корневого каталога исходного кода QGraphFlow, а не из каталога вашего приложения. Они устанавливают полный пакет из вложенного каталога `dist/runtime`.
32
+ Выполняйте команды ниже из корневого каталога плагина, в который вы перешли на шаге 1 (`qgraphflow-install/node_modules/qgraphflow`), а не из каталога вашего приложения.
33
33
 
34
34
  ### Codex App / CLI
35
35
 
36
36
  ```bash
37
- codex plugin marketplace add ./dist/runtime
37
+ codex plugin marketplace add .
38
38
  codex plugin add qgraphflow@supermax92
39
39
  ```
40
40
 
@@ -44,17 +44,8 @@ codex plugin add qgraphflow@supermax92
44
44
 
45
45
  ### Claude Code
46
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
47
  ```bash
57
- claude plugin marketplace add ./dist/runtime
48
+ claude plugin marketplace add ./
58
49
  claude plugin install qgraphflow@supermax92 --scope user
59
50
  ```
60
51
 
@@ -63,20 +54,20 @@ claude plugin install qgraphflow@supermax92 --scope user
63
54
  ### Qoder CLI
64
55
 
65
56
  ```bash
66
- qodercli plugins install ./dist/runtime
57
+ qodercli plugins install .
67
58
  ```
68
59
 
69
60
  Начните новый сеанс и выберите `q-flow`.
70
61
 
71
62
  ### Qoder Desktop
72
63
 
73
- **Рекомендуется:** Откройте **Settings → Plugins → Marketplace**, найдите **代码图谱可视化** или **qgraphflow** и установите плагин. Начните новый сеанс и выберите `q-flow`. Скачивать ZIP или собирать исходный код не требуется.
64
+ **Рекомендуется:** Откройте **Settings → Plugins → Marketplace**, найдите **QGraphFlow** или **代码图谱可视化** и установите плагин. Начните новый сеанс и выберите `q-flow`.
74
65
 
75
- Для локальной установки выполните шаг 1, затем откройте **Settings → Plugins → Custom → Import** и импортируйте весь каталог `dist/runtime`. Перезагрузите клиент и выберите `q-flow`.
66
+ Для локальной установки выполните шаг 1, затем откройте **Settings → Plugins → Custom → Import** и импортируйте весь корневой каталог плагина. Перезагрузите клиент и выберите `q-flow`.
76
67
 
77
68
  ### Cursor
78
69
 
79
- Скопируйте всё содержимое `dist/runtime`, включая скрытые файлы, в `~/.cursor/plugins/local/qgraphflow/`. Если каталог уже существует, сначала сделайте резервную копию; не смешивайте старые и новые файлы.
70
+ Скопируйте всё содержимое корневого каталога плагина, включая скрытые файлы, в `~/.cursor/plugins/local/qgraphflow/`. Если каталог уже существует, сначала сделайте резервную копию; не смешивайте старые и новые файлы.
80
71
 
81
72
  Убедитесь, что манифест находится по адресу `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Перезагрузите окно и выберите `q-flow` в Customize → Plugins / Skills.
82
73
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  [返回 README](readme/README.zh-CN.md)
6
6
 
7
- Qoder Desktop 可从插件商城安装,Claude Code 可直接从 GitHub 安装(见下方对应小节),两者均可跳过第 1 步。采用本地安装时,先下载 QGraphFlow 源码并构建运行包。
7
+ Qoder Desktop 可从插件商城安装,跳过第 1 步(见下方对应小节)。其他客户端安装从 npmjs.com 下载的插件包。
8
8
 
9
- 准备 Node.js 22 及以上版本,以及已配置好模型访问的客户端。从源码构建还需 Git、npm、`tar`、`zip` 和 `unzip`。
9
+ 准备 Node.js 22 及以上版本(含 npm),以及已配置好模型访问的客户端。
10
10
 
11
11
  ## 快速安装
12
12
 
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
16
16
 
17
17
  为 Claude Code、Codex、Cursor 和 Qoder 安装技能 `q-flow`(已用 `skills` 1.7.0 实测),命令会询问装到哪些客户端。如需以插件方式安装,按以下步骤操作。
18
18
 
19
- ## 1. 下载并构建(用于本地安装)
19
+ ## 1. 从 npm 下载插件
20
20
 
21
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
22
+ mkdir qgraphflow-install
23
+ cd qgraphflow-install
24
+ npm install qgraphflow --ignore-scripts
25
+ cd node_modules/qgraphflow
26
26
  ```
27
27
 
28
- 已有 QGraphFlow 源码可跳过克隆,并进入其根目录。ZIP 文件名以 QGraphFlow 的 `package.json` 版本为准;使用新的输出和解压目录,不覆盖旧文件。Git 下载只包含已推送的代码,不包含尚未提交的本地修改。
28
+ 在业务项目之外创建该目录,无需账号、登录或令牌。此时已进入插件根目录。npm 下载不会自动完成客户端安装,请继续第 2 步。如需安装尚未发布的代码,参见[源码构建说明](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally)。
29
29
 
30
30
  ## 2. 选择客户端安装
31
31
 
32
- 以下命令均在 QGraphFlow 源码根目录执行,不是你的业务项目目录。安装的是该目录下 `dist/runtime` 中的完整运行包。
32
+ 以下命令均在第 1 步进入的插件根目录(`qgraphflow-install/node_modules/qgraphflow`)执行,不是你的业务项目目录。
33
33
 
34
34
  ### Codex App / CLI
35
35
 
36
36
  ```bash
37
- codex plugin marketplace add ./dist/runtime
37
+ codex plugin marketplace add .
38
38
  codex plugin add qgraphflow@supermax92
39
39
  ```
40
40
 
@@ -44,17 +44,8 @@ codex plugin add qgraphflow@supermax92
44
44
 
45
45
  ### Claude Code
46
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
47
  ```bash
57
- claude plugin marketplace add ./dist/runtime
48
+ claude plugin marketplace add ./
58
49
  claude plugin install qgraphflow@supermax92 --scope user
59
50
  ```
60
51
 
@@ -63,20 +54,20 @@ claude plugin install qgraphflow@supermax92 --scope user
63
54
  ### Qoder CLI
64
55
 
65
56
  ```bash
66
- qodercli plugins install ./dist/runtime
57
+ qodercli plugins install .
67
58
  ```
68
59
 
69
60
  新建会话,选择 `q-flow`。
70
61
 
71
62
  ### Qoder Desktop
72
63
 
73
- **推荐:**打开 **Settings → Plugins → Marketplace**,搜索 **代码图谱可视化** 或 **qgraphflow**,安装插件。新建会话,选择 `q-flow`。无需下载 ZIP 或构建源码。
64
+ **推荐:**打开 **Settings → Plugins → Marketplace**,搜索 **QGraphFlow** 或 **代码图谱可视化**,安装插件。新建会话,选择 `q-flow`。
74
65
 
75
- 如需本地安装,先完成第 1 步,再打开 **Settings → Plugins → Custom → Import**,导入完整的 `dist/runtime` 目录;重新加载后选择 `q-flow`。
66
+ 如需本地安装,先完成第 1 步,再打开 **Settings → Plugins → Custom → Import**,导入完整的插件根目录;重新加载后选择 `q-flow`。
76
67
 
77
68
  ### Cursor
78
69
 
79
- 将 `dist/runtime` 内的全部内容(含隐藏文件)复制到 `~/.cursor/plugins/local/qgraphflow/`。已有目录先备份,勿混合新旧文件。
70
+ 将插件根目录内的全部内容(含隐藏文件)复制到 `~/.cursor/plugins/local/qgraphflow/`。已有目录先备份,勿混合新旧文件。
80
71
 
81
72
  确认清单位于 `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`,重新加载窗口,在 Customize → Plugins / Skills 中选择 `q-flow`。
82
73