@igoruehara/canvas-flow 0.1.5 → 0.1.7

package/README.md

@@ -1,15 +1,72 @@
 # Canvas Flow
 
-Canvas Flow roda frontend e backend juntos a partir de um pacote npm.
+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.
+
+Use quando quiser:
+
+- criar automacoes com agentes de IA;
+- conectar prompts, ferramentas, webhooks e documentos;
+- testar fluxos localmente antes de publicar;
+- usar RAG com documentos;
+- expor fluxos por API ou webhook.
+
+## Inicio Rapido
+
+Com Docker, o Canvas Flow sobe MongoDB local automaticamente e abre o navegador:
+
+```bash
+npx @igoruehara/canvas-flow@latest --with-docker --open
+```
+
+Sem Docker, use quando voce ja tem MongoDB local, MongoDB Atlas ou outro Mongo remoto:
+
+```bash
+npx @igoruehara/canvas-flow@latest --open
+```
+
+Na primeira execucao o CLI cria `~/.canvas-flow/config.json`, gera secrets locais e inicia o app em:
+
+```txt
+http://localhost:3333
+```
 
 ## Requisitos
 
 - Node.js 20+
-- Docker Desktop opcional, apenas para subir Mongo/Milvus localmente
+- MongoDB local, MongoDB remoto ou Docker Desktop
+- Docker Desktop opcional para subir MongoDB, Milvus, MinIO e etcd localmente
+
+## O Que Ele Entrega
+
+- editor visual para montar fluxos multiagente;
+- execucao local de frontend e API no mesmo processo Node;
+- configuracao de provedores de IA pela UI ou pelo `config.json`;
+- RAG com Milvus/Zilliz ou Azure AI Search;
+- entrada por API, webhook, web widget e canais configurados no app;
+- chaves de API para consumir fluxos publicados;
+- validacao do ambiente com `doctor`.
+
+## Interface
+
+### Editor Visual
+
+![Editor visual de fluxos do Canvas Flow](https://cdn.jsdelivr.net/npm/@igoruehara/canvas-flow@0.1.7/docs/screenshots/flow-editor.png)
+
+### Teste Do Fluxo
 
-## Rodar com Docker
+![Editor visual com painel de teste do fluxo](https://cdn.jsdelivr.net/npm/@igoruehara/canvas-flow@0.1.7/docs/screenshots/flow-editor-test-panel.png)
 
-Este caminho sobe MongoDB local automaticamente e abre o navegador.
+### Biblioteca De Componentes
+
+![Biblioteca de componentes do Canvas Flow](https://cdn.jsdelivr.net/npm/@igoruehara/canvas-flow@0.1.7/docs/screenshots/component-library.png)
+
+### Provedores
+
+![Tela de provedores do Canvas Flow](https://cdn.jsdelivr.net/npm/@igoruehara/canvas-flow@0.1.7/docs/screenshots/providers.png)
+
+## Rodar Com Docker
+
+Para ambiente local simples, suba MongoDB junto com o Canvas Flow:
 
 ```bash
 npx @igoruehara/canvas-flow@latest --with-docker --open
@@ -32,7 +89,7 @@ npx @igoruehara/canvas-flow@latest infra down
 
 `infra down` para os containers, mas mantem os volumes Docker.
 
-## Rodar sem Docker
+## Rodar Sem Docker
 
 Use este caminho quando voce ja tem MongoDB local, Atlas ou outro Mongo remoto.
 
@@ -102,7 +159,7 @@ npx @igoruehara/canvas-flow@latest --config C:\canvas-flow\config.json --open
 npx @igoruehara/canvas-flow@latest --home C:\canvas-flow-data --open
 ```
 
-### Campos principais
+## Campos Principais Do Config
 
 `server`: controla porta, URL publica, Swagger, CORS e abertura do navegador.
 
@@ -185,7 +242,7 @@ Tambem e possivel configurar provedores pela propria aplicacao depois que ela es
 
 `runtime` e `aws`: opcionais. Ajustam timezone, execucao de cron, limites do runtime e regiao AWS.
 
-## Validar
+## Validar Ambiente
 
 ```bash
 npx @igoruehara/canvas-flow@latest doctor
@@ -197,7 +254,28 @@ Sem checar rede/Mongo:
 npx @igoruehara/canvas-flow@latest doctor --offline
 ```
 
-## Instalar globalmente
+Para tratar avisos como erro:
+
+```bash
+npx @igoruehara/canvas-flow@latest doctor --strict
+```
+
+## Comandos Do CLI
+
+```bash
+npx @igoruehara/canvas-flow@latest init
+npx @igoruehara/canvas-flow@latest config
+npx @igoruehara/canvas-flow@latest config --edit
+npx @igoruehara/canvas-flow@latest config --show
+npx @igoruehara/canvas-flow@latest doctor
+npx @igoruehara/canvas-flow@latest infra up
+npx @igoruehara/canvas-flow@latest infra up --full
+npx @igoruehara/canvas-flow@latest infra status
+npx @igoruehara/canvas-flow@latest infra logs
+npx @igoruehara/canvas-flow@latest infra down
+```
+
+## Instalar Globalmente
 
 Opcional:
 
@@ -205,3 +283,9 @@ Opcional:
 npm i -g @igoruehara/canvas-flow
 canvas-flow --with-docker --open
 ```
+
+## Seguranca
+
+- Nao publique `~/.canvas-flow/config.json`.
+- Nao exponha `auth.apiToken`, `jwtSecret`, `mediaProxySecret` ou chaves de provedores.
+- Para uso publico ou producao, revise login, CORS, Swagger, limites de API, armazenamento de arquivos e provedores antes de expor o app.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@igoruehara/canvas-flow",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Standalone npm launcher for Canvas Flow multi-agent GenAI workflows.",
   "keywords": [
     "IA",
@@ -16,6 +16,7 @@
   },
   "files": [
     "bin",
+    "docs/screenshots",
     "public",
     "server",
     "templates",