@igoruehara/canvas-flow 0.1.5 → 0.1.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/README.md +74 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,54 @@
|
|
|
1
1
|
# Canvas Flow
|
|
2
2
|
|
|
3
|
-
Canvas Flow
|
|
3
|
+
Canvas Flow e uma aplicacao web local para criar, testar e executar fluxos de IA multiagente em formato visual. O pacote npm sobe frontend e backend juntos em um unico comando.
|
|
4
|
+
|
|
5
|
+
Use quando quiser:
|
|
6
|
+
|
|
7
|
+
- criar automacoes com agentes de IA;
|
|
8
|
+
- conectar prompts, ferramentas, webhooks e documentos;
|
|
9
|
+
- testar fluxos localmente antes de publicar;
|
|
10
|
+
- usar RAG com documentos;
|
|
11
|
+
- expor fluxos por API ou webhook.
|
|
12
|
+
|
|
13
|
+
## Inicio Rapido
|
|
14
|
+
|
|
15
|
+
Com Docker, o Canvas Flow sobe MongoDB local automaticamente e abre o navegador:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx @igoruehara/canvas-flow@latest --with-docker --open
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Sem Docker, use quando voce ja tem MongoDB local, MongoDB Atlas ou outro Mongo remoto:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx @igoruehara/canvas-flow@latest --open
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Na primeira execucao o CLI cria `~/.canvas-flow/config.json`, gera secrets locais e inicia o app em:
|
|
28
|
+
|
|
29
|
+
```txt
|
|
30
|
+
http://localhost:3333
|
|
31
|
+
```
|
|
4
32
|
|
|
5
33
|
## Requisitos
|
|
6
34
|
|
|
7
35
|
- Node.js 20+
|
|
8
|
-
-
|
|
36
|
+
- MongoDB local, MongoDB remoto ou Docker Desktop
|
|
37
|
+
- Docker Desktop opcional para subir MongoDB, Milvus, MinIO e etcd localmente
|
|
38
|
+
|
|
39
|
+
## O Que Ele Entrega
|
|
40
|
+
|
|
41
|
+
- editor visual para montar fluxos multiagente;
|
|
42
|
+
- execucao local de frontend e API no mesmo processo Node;
|
|
43
|
+
- configuracao de provedores de IA pela UI ou pelo `config.json`;
|
|
44
|
+
- RAG com Milvus/Zilliz ou Azure AI Search;
|
|
45
|
+
- entrada por API, webhook, web widget e canais configurados no app;
|
|
46
|
+
- chaves de API para consumir fluxos publicados;
|
|
47
|
+
- validacao do ambiente com `doctor`.
|
|
9
48
|
|
|
10
|
-
## Rodar
|
|
49
|
+
## Rodar Com Docker
|
|
11
50
|
|
|
12
|
-
|
|
51
|
+
Para ambiente local simples, suba MongoDB junto com o Canvas Flow:
|
|
13
52
|
|
|
14
53
|
```bash
|
|
15
54
|
npx @igoruehara/canvas-flow@latest --with-docker --open
|
|
@@ -32,7 +71,7 @@ npx @igoruehara/canvas-flow@latest infra down
|
|
|
32
71
|
|
|
33
72
|
`infra down` para os containers, mas mantem os volumes Docker.
|
|
34
73
|
|
|
35
|
-
## Rodar
|
|
74
|
+
## Rodar Sem Docker
|
|
36
75
|
|
|
37
76
|
Use este caminho quando voce ja tem MongoDB local, Atlas ou outro Mongo remoto.
|
|
38
77
|
|
|
@@ -102,7 +141,7 @@ npx @igoruehara/canvas-flow@latest --config C:\canvas-flow\config.json --open
|
|
|
102
141
|
npx @igoruehara/canvas-flow@latest --home C:\canvas-flow-data --open
|
|
103
142
|
```
|
|
104
143
|
|
|
105
|
-
|
|
144
|
+
## Campos Principais Do Config
|
|
106
145
|
|
|
107
146
|
`server`: controla porta, URL publica, Swagger, CORS e abertura do navegador.
|
|
108
147
|
|
|
@@ -185,7 +224,7 @@ Tambem e possivel configurar provedores pela propria aplicacao depois que ela es
|
|
|
185
224
|
|
|
186
225
|
`runtime` e `aws`: opcionais. Ajustam timezone, execucao de cron, limites do runtime e regiao AWS.
|
|
187
226
|
|
|
188
|
-
## Validar
|
|
227
|
+
## Validar Ambiente
|
|
189
228
|
|
|
190
229
|
```bash
|
|
191
230
|
npx @igoruehara/canvas-flow@latest doctor
|
|
@@ -197,7 +236,28 @@ Sem checar rede/Mongo:
|
|
|
197
236
|
npx @igoruehara/canvas-flow@latest doctor --offline
|
|
198
237
|
```
|
|
199
238
|
|
|
200
|
-
|
|
239
|
+
Para tratar avisos como erro:
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
npx @igoruehara/canvas-flow@latest doctor --strict
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
## Comandos Do CLI
|
|
246
|
+
|
|
247
|
+
```bash
|
|
248
|
+
npx @igoruehara/canvas-flow@latest init
|
|
249
|
+
npx @igoruehara/canvas-flow@latest config
|
|
250
|
+
npx @igoruehara/canvas-flow@latest config --edit
|
|
251
|
+
npx @igoruehara/canvas-flow@latest config --show
|
|
252
|
+
npx @igoruehara/canvas-flow@latest doctor
|
|
253
|
+
npx @igoruehara/canvas-flow@latest infra up
|
|
254
|
+
npx @igoruehara/canvas-flow@latest infra up --full
|
|
255
|
+
npx @igoruehara/canvas-flow@latest infra status
|
|
256
|
+
npx @igoruehara/canvas-flow@latest infra logs
|
|
257
|
+
npx @igoruehara/canvas-flow@latest infra down
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
## Instalar Globalmente
|
|
201
261
|
|
|
202
262
|
Opcional:
|
|
203
263
|
|
|
@@ -205,3 +265,9 @@ Opcional:
|
|
|
205
265
|
npm i -g @igoruehara/canvas-flow
|
|
206
266
|
canvas-flow --with-docker --open
|
|
207
267
|
```
|
|
268
|
+
|
|
269
|
+
## Seguranca
|
|
270
|
+
|
|
271
|
+
- Nao publique `~/.canvas-flow/config.json`.
|
|
272
|
+
- Nao exponha `auth.apiToken`, `jwtSecret`, `mediaProxySecret` ou chaves de provedores.
|
|
273
|
+
- Para uso publico ou producao, revise login, CORS, Swagger, limites de API, armazenamento de arquivos e provedores antes de expor o app.
|