shark-ai 0.0.1
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/CHANGELOG.md +63 -0
- package/LICENSE +21 -0
- package/README.en.md +349 -0
- package/README.md +349 -0
- package/dist/bin/shark.d.ts +1 -0
- package/dist/bin/shark.js +1854 -0
- package/dist/bin/shark.js.map +1 -0
- package/dist/chunk-B7PNFPUX.js +538 -0
- package/dist/chunk-B7PNFPUX.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -0
- package/package.json +85 -0
package/README.md
ADDED
|
@@ -0,0 +1,349 @@
|
|
|
1
|
+
# 🦈 Shark AI
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
|
7
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⣾⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
|
8
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⣀⣀⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣰⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
|
|
9
|
+
⢠⣾⣿⣏⠉⠉⠉⠉⠉⠉⢡⣶⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⠻⢿⣿⣿⣿⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⡄⠀
|
|
10
|
+
⠈⣿⣿⣿⣿⣦⣽⣦⡀⠀⠀⠛⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠛⢧⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⣿⣿⠀⠀
|
|
11
|
+
⠀⠘⢿⣿⣿⣿⣿⣿⣿⣦⣄⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣾⣿⣿⠇⠀⠀
|
|
12
|
+
⠀⠀⠈⠻⣿⣿⣿⣿⡟⢿⠻⠛⠙⠉⠋⠛⠳⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⣿⣿⣿⡟⠀⠀⠀
|
|
13
|
+
⠀⠀⠀⠀⠈⠙⢿⡇⣠⣤⣶⣶⣾⡉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⣰⣰⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠠⠾⢇⠀⠀⠀⠀⠀⣴⣿⣿⣿⣿⠃⠀⠀⠀
|
|
14
|
+
⠀⠀⠀⠀⠀⠀⠀⠱⣿⣿⣿⣿⣿⣿⣦⡀⠀⠀⠀⠀⠀⠀⠀⠀⣰⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠐⠤⢤⣀⣀⣀⣀⣀⣀⣠⣤⣤⣤⣬⣭⣿⣿⠀⠀⠀⠀
|
|
15
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠈⠛⢿⣿⣿⣿⣿⣿⣶⣤⣄⣀⣀⣠⣴⣾⣿⣿⣿⣷⣤⣀⡀⠀⠀⠀⠀⠀⠀⣀⣀⣤⣾⣿⣿⣿⣿⡿⠿⠛⠛⠻⣿⣿⣿⣿⣇⠀⠀⠀
|
|
16
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠙⠻⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣶⣶⣤⣤⣘⡛⠿⢿⡿⠟⠛⠉⠁⠀⠀⠀⠀⠀⠈⠻⣿⣿⣿⣦⠀⠀
|
|
17
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣴⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠿⢿⣿⣿⣿⣿⣿⣶⣦⣤⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠻⣿⣿⡄⠀
|
|
18
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣾⣿⣿⣿⠿⠛⠉⠁⠀⠈⠉⠙⠛⠛⠻⠿⠿⠿⠿⠟⠛⠃⠀⠀⠀⠉⠉⠉⠛⠛⠛⠿⠿⠿⣶⣦⣄⡀⠀⠀⠀⠀⠀⠈⠙⠛⠂
|
|
19
|
+
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠠⠿⠛⠋⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀
|
|
20
|
+
|
|
21
|
+
____ _ _ _ ____ _ __ _ ___
|
|
22
|
+
/ ___|| | | | / \ | _ \| |/ / / \ |_ _|
|
|
23
|
+
\___ \| |_| |/ _ \ | |_) | ' / / _ \ | |
|
|
24
|
+
___) | _ / ___ \| _ <| . \ / ___ \ | |
|
|
25
|
+
|____/|_| |_/_/ \_\_| \_\_|\_\ /_/ \_\___|
|
|
26
|
+
|
|
27
|
+
AI-Native Collaborative Development Tool
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Ferramenta de Desenvolvimento Colaborativo com IA**
|
|
32
|
+
|
|
33
|
+
*Transforme o desenvolvimento com IA em um processo estruturado e transparente*
|
|
34
|
+
|
|
35
|
+
[](https://www.npmjs.com/package/shark-ai)
|
|
36
|
+
[](https://opensource.org/licenses/MIT)
|
|
37
|
+
[](https://nodejs.org/)
|
|
38
|
+
|
|
39
|
+
[English](./README.en.md) | **Português**
|
|
40
|
+
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## 🎯 O Que é o Shark AI?
|
|
46
|
+
|
|
47
|
+
**Shark AI** é uma ferramenta de linha de comando open-source que eleva o desenvolvimento assistido por IA a um novo patamar através de um **workflow colaborativo, estruturado e persistente**.
|
|
48
|
+
|
|
49
|
+
O Shark AI **amplifica suas capacidades** orquestrando um pipeline de agentes especializados (Business Analyst, Specification, Architect, Developer) integrados nativamente com a **StackSpot AI**, mantendo você sempre no controle das decisões críticas.
|
|
50
|
+
|
|
51
|
+
### 💡 Inspiração: BMAD Method
|
|
52
|
+
|
|
53
|
+
O coração do Shark AI é inspirado no **[BMAD (Business Model Agile Development)](https://github.com/bmad-method)** - uma metodologia estruturada para desenvolvimento ágil com IA. O Shark AI adapta os princípios do BMAD para criar um CLI que mantém o desenvolvedor no controle enquanto a IA executa o trabalho pesado.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## ✨ Features Principais
|
|
58
|
+
|
|
59
|
+
### 🤝 Human-in-the-Loop Inteligente
|
|
60
|
+
Colaboração estruturada onde **você aprova** as decisões críticas de arquitetura e design, enquanto a IA executa tarefas repetitivas.
|
|
61
|
+
|
|
62
|
+
### 📁 Persistência de Estado
|
|
63
|
+
Mantém um arquivo de workflow vivo (`shark-workflow.json`) que rastreia o progresso passo a passo. **Pause e retome** o trabalho entre sessões sem perder contexto.
|
|
64
|
+
|
|
65
|
+
### 🔗 Integração Nativa StackSpot AI
|
|
66
|
+
Acesso direto a **Knowledge Sources** e padrões da empresa, garantindo que o código gerado siga automaticamente as diretrizes corporativas.
|
|
67
|
+
|
|
68
|
+
### 🔄 Auto-Healing Real
|
|
69
|
+
Loops de feedback autônomos que executam builds, detectam erros e **corrigem automaticamente** (até 5 tentativas) antes de solicitar sua intervenção.
|
|
70
|
+
|
|
71
|
+
### 🎨 Interface de Terminal Rica
|
|
72
|
+
TUI (Text User Interface) com menus interativos, cores, spinners e feedback visual para uma experiência premium no terminal.
|
|
73
|
+
|
|
74
|
+
### 🧠 Orquestração Multi-Agente
|
|
75
|
+
Pipeline completo de desenvolvimento:
|
|
76
|
+
```
|
|
77
|
+
Business Analyst → Specification → Architecture → Development
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 🚀 Instalação
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm install -g shark-ai
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**Requisitos:**
|
|
89
|
+
- Node.js >= 20.0.0
|
|
90
|
+
- Conta StackSpot AI (para autenticação)
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## ⚡ Quick Start
|
|
95
|
+
|
|
96
|
+
### 1. Autentique com StackSpot
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
shark login
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
O navegador abrirá automaticamente para autenticação OAuth. Seus tokens serão armazenados de forma segura no sistema operacional.
|
|
103
|
+
|
|
104
|
+
### 2. Inicialize um Projeto
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
shark init
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
O Shark AI perguntará:
|
|
111
|
+
- Qual stack você está usando? (React, Next.js, Angular)
|
|
112
|
+
- Novo workflow ou continuar existente?
|
|
113
|
+
- O que você quer construir?
|
|
114
|
+
|
|
115
|
+
### 3. Deixe os Agentes Trabalharem
|
|
116
|
+
|
|
117
|
+
O Shark orquestrará automaticamente:
|
|
118
|
+
|
|
119
|
+
1. **Business Analyst Agent** → Entende seus requisitos e cria um briefing
|
|
120
|
+
2. **Specification Agent** → Transforma o briefing em especificação técnica
|
|
121
|
+
3. **Architect Agent** → Projeta a arquitetura da solução
|
|
122
|
+
4. **Developer Agent** → Gera o código e executa testes
|
|
123
|
+
|
|
124
|
+
**Você aprova cada etapa crítica.** A IA executa, você decide.
|
|
125
|
+
|
|
126
|
+
### 4. Auto-Healing em Ação
|
|
127
|
+
|
|
128
|
+
Se houver erros de build ou lint, o Shark:
|
|
129
|
+
1. Executa o build/test automaticamente
|
|
130
|
+
2. Captura o erro (stderr)
|
|
131
|
+
3. Envia para o Developer Agent corrigir
|
|
132
|
+
4. Tenta novamente (até 5x)
|
|
133
|
+
5. Se falhar, pede sua ajuda
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## 📚 Comandos Disponíveis
|
|
138
|
+
|
|
139
|
+
### `shark login`
|
|
140
|
+
Autentica com StackSpot AI via OAuth 2.0.
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
shark login
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### `shark init`
|
|
147
|
+
Inicializa um novo workflow ou retoma um existente.
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
shark init
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
O Shark detecta automaticamente se há um workflow em andamento e oferece opções para:
|
|
154
|
+
- Continuar de onde parou
|
|
155
|
+
- Iniciar um novo workflow
|
|
156
|
+
- Visualizar o progresso atual
|
|
157
|
+
|
|
158
|
+
### `shark config`
|
|
159
|
+
Gerencia configurações globais do Shark AI.
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
shark config
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Abre um menu interativo para configurar:
|
|
166
|
+
- Tokens de API
|
|
167
|
+
- Preferências de interface
|
|
168
|
+
- Configurações padrão de projeto
|
|
169
|
+
|
|
170
|
+
### `shark ba`
|
|
171
|
+
Inicia uma sessão interativa com o **Business Analyst Agent**.
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
shark ba
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
Use quando quiser:
|
|
178
|
+
- Refinar requisitos de negócio
|
|
179
|
+
- Criar briefings detalhados
|
|
180
|
+
- Validar critérios de aceitação
|
|
181
|
+
|
|
182
|
+
### `shark spec`
|
|
183
|
+
Inicia o **Specification Agent** para criar especificações técnicas.
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
shark spec [--briefing <caminho>]
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**Opções:**
|
|
190
|
+
- `--briefing`: Caminho para arquivo de briefing existente
|
|
191
|
+
- `--id`: ID customizado do agente
|
|
192
|
+
|
|
193
|
+
### `shark dev`
|
|
194
|
+
Ativa o **Developer Agent** para geração de código.
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
shark dev
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### `shark qa`
|
|
201
|
+
Executa o **QA Agent** para testes e validação.
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
shark qa
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### `shark scan`
|
|
208
|
+
Escaneia o projeto atual e analisa a estrutura.
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
shark scan
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
|
|
216
|
+
## 🎯 Casos de Uso
|
|
217
|
+
|
|
218
|
+
### 👨💼 Carlos - Senior Developer
|
|
219
|
+
**Situação:** Precisa criar um módulo de extrato financeiro complexo mas foi interrompido para uma reunião.
|
|
220
|
+
|
|
221
|
+
**Com Shark AI:**
|
|
222
|
+
1. Inicia `shark init`, descreve o módulo
|
|
223
|
+
2. Aprova a arquitetura proposta pelo Architect Agent
|
|
224
|
+
3. **Sai para a reunião** (fecha o terminal)
|
|
225
|
+
4. Volta 2 horas depois, roda `shark init` novamente
|
|
226
|
+
5. **Shark retoma exatamente de onde parou** - zero contexto perdido
|
|
227
|
+
6. Developer Agent completa a implementação
|
|
228
|
+
|
|
229
|
+
**Resultado:** Módulo pronto em < 1 hora de trabalho real vs 4-6 horas manual.
|
|
230
|
+
|
|
231
|
+
### 👩💻 Julia - Junior Developer
|
|
232
|
+
**Situação:** Primeira vez otimizando performance de um dashboard.
|
|
233
|
+
|
|
234
|
+
**Com Shark AI:**
|
|
235
|
+
1. `shark ba` - O Business Analyst explica métricas de performance (LCP, FID)
|
|
236
|
+
2. `shark spec` - Specification Agent define alvos mensuráveis
|
|
237
|
+
3. Durante desenvolvimento, Auto-Healing corrige um loop infinito no `useEffect`
|
|
238
|
+
4. **Julia aprende** lendo os diffs e explicações da IA
|
|
239
|
+
|
|
240
|
+
**Resultado:** Feature otimizada + aprendizado real sobre Web Vitals.
|
|
241
|
+
|
|
242
|
+
### 👩💼 Ana - Tech Lead
|
|
243
|
+
**Situação:** Garantir que toda a equipe siga novos padrões de backend.
|
|
244
|
+
|
|
245
|
+
**Com Shark AI:**
|
|
246
|
+
1. Atualiza documento "Backend Standards" no StackSpot Knowledge Source
|
|
247
|
+
2. **Não precisa avisar ninguém**
|
|
248
|
+
3. Quando Carlos e Julia rodam Shark, os agentes consultam o Knowledge Source atualizado
|
|
249
|
+
4. Código gerado já nasce seguindo os novos padrões
|
|
250
|
+
|
|
251
|
+
**Resultado:** Compliance 100% + PRs aprovados rapidamente.
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## 🏗️ Arquitetura
|
|
256
|
+
|
|
257
|
+
### Pipeline de Agentes
|
|
258
|
+
|
|
259
|
+
```mermaid
|
|
260
|
+
graph LR
|
|
261
|
+
A[shark init] --> B[Business Analyst]
|
|
262
|
+
B --> C[Specification Agent]
|
|
263
|
+
C --> D[Architect Agent]
|
|
264
|
+
D --> E[Developer Agent]
|
|
265
|
+
E --> F{Build OK?}
|
|
266
|
+
F -->|Sim| G[✅ Concluído]
|
|
267
|
+
F -->|Não| H[Auto-Healing]
|
|
268
|
+
H --> E
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Persistência de Estado
|
|
272
|
+
|
|
273
|
+
O arquivo `shark-workflow.json` armazena:
|
|
274
|
+
- Histórico de todas as decisões
|
|
275
|
+
- Estado atual do pipeline
|
|
276
|
+
- Artefatos gerados por cada agente
|
|
277
|
+
- Contexto da sessão
|
|
278
|
+
|
|
279
|
+
**Você pode pausar e retomar a qualquer momento.**
|
|
280
|
+
|
|
281
|
+
### Integração StackSpot
|
|
282
|
+
|
|
283
|
+
```
|
|
284
|
+
┌─────────────┐
|
|
285
|
+
│ Shark CLI │
|
|
286
|
+
└──────┬──────┘
|
|
287
|
+
│
|
|
288
|
+
├──► StackSpot AI API
|
|
289
|
+
│ (Agentes)
|
|
290
|
+
│
|
|
291
|
+
└──► Knowledge Sources
|
|
292
|
+
(Padrões da Empresa)
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
## 🔒 Segurança
|
|
298
|
+
|
|
299
|
+
- ✅ **Tokens armazenados de forma segura** usando keychain do SO
|
|
300
|
+
- ✅ **Zero vazamento de código** - comunicação restrita à API StackSpot (SOC2 compliant)
|
|
301
|
+
- ✅ **Arquivos sensíveis protegidos** - `.gitignore` configurado para prevenir commit de secrets
|
|
302
|
+
- ✅ **OAuth 2.0** para autenticação segura
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
## 🤝 Contribuindo
|
|
307
|
+
|
|
308
|
+
Contribuições são bem-vindas! Veja [CONTRIBUTING.md](./CONTRIBUTING.md) para detalhes sobre:
|
|
309
|
+
- Como reportar bugs
|
|
310
|
+
- Como sugerir features
|
|
311
|
+
- Processo de Pull Request
|
|
312
|
+
- Coding standards
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
## 📝 Changelog
|
|
317
|
+
|
|
318
|
+
Veja [CHANGELOG.md](./CHANGELOG.md) para histórico de versões e mudanças.
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## 📄 Licença
|
|
323
|
+
|
|
324
|
+
Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](./LICENSE) para detalhes.
|
|
325
|
+
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
## 💬 Suporte
|
|
329
|
+
|
|
330
|
+
- **Issues:** [GitHub Issues](https://github.com/miguelarcjr/shark-ai/issues)
|
|
331
|
+
- **Discussões:** [GitHub Discussions](https://github.com/miguelarcjr/shark-ai/discussions)
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
## 🙏 Agradecimentos
|
|
336
|
+
|
|
337
|
+
- **[BMAD Method](https://github.com/bmad-method)** - Inspiração metodológica
|
|
338
|
+
- **[StackSpot AI](https://stackspot.com)** - Plataforma de agentes de IA
|
|
339
|
+
- **Comunidade Open Source** - Por tornar tudo isso possível
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
<div align="center">
|
|
344
|
+
|
|
345
|
+
**Feito com ❤️ por [Miguel Arcangelo](https://github.com/miguelarcjr)**
|
|
346
|
+
|
|
347
|
+
Se o Shark AI te ajudou, considere dar uma ⭐ no projeto!
|
|
348
|
+
|
|
349
|
+
</div>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|