# Referência da CLI

Todos os comandos do yby, com a mesma ajuda de `yby <comando> --help`.

## yby

Yby CLI: Plataforma de Engenharia e Assistente Inteligente para clusters Kubernetes.
Atua no bootstrap, governança e operação assistida, complementando o uso do kubectl.

**Uso**

```
yby <comando>
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby access](#yby-access) — Abre túneis de acesso aos serviços do cluster
* [yby atlas](#yby-atlas) — Mapa da topologia da infraestrutura em diagramas Mermaid, refinados pela IA
* [yby bard](#yby-bard) — Assistente de IA do cluster: conversa, ferramentas e diagnóstico
* [yby bootstrap](#yby-bootstrap) — Comandos para bootstrap (VPS ou Cluster)
* [yby chart](#yby-chart) — Gerenciamento de Helm Charts (Workload Abstraction)
* [yby cloud](#yby-cloud) — Gerencia clusters em AWS, Azure e GCP (beta)
* [yby completion](#yby-completion) — Gera script de autocompletar para seu shell
* [yby destroy](#yby-destroy) — Destroi o ambiente (cluster k3d)
* [yby doctor](#yby-doctor) — Verifica dependências e saúde do ambiente
* [yby env](#yby-env) — Gerencia ambientes e contextos (dev, staging, prod)
* [yby generate](#yby-generate) — Gera recursos e manifestos
* [yby init](#yby-init) — Inicializa um novo projeto Yby (Scaffold)
* [yby logs](#yby-logs) — Exibe logs de um pod do cluster
* [yby plugin](#yby-plugin) — Gerencia plugins do YBY CLI
* [yby secret](#yby-secret) — Gerenciamento de Segredos (Webhooks, MinIO, SealedSecrets)
* [yby sentinel](#yby-sentinel) — Auditoria de segurança K8s com scan de vulnerabilidades e investigação por IA
* [yby setup](#yby-setup) — Configura o ambiente de desenvolvimento local
* [yby status](#yby-status) — Verifica status do cluster e apps
* [yby synapstor](#yby-synapstor) — Gestão de conhecimento do projeto: UKIs, busca semântica, nota de qualidade e exportação
* [yby telemetry](#yby-telemetry) — Gerencia dados de telemetria do Yby CLI
* [yby uki](#yby-uki) — Gerencia Unidades de Conhecimento Interligada (UKIs)
* [yby uninstall](#yby-uninstall) — Desinstala o Yby CLI do sistema
* [yby up](#yby-up) — Inicia ou verifica o ambiente (Local = Sync, Remoto = Check)
* [yby upgrade](#yby-upgrade) — Atualiza o Yby CLI para a versão mais recente
* [yby validate](#yby-validate) — Valida charts Helm e manifests
* [yby version](#yby-version) — Exibe informações de versão do Yby CLI
* [yby viz](#yby-viz) — Painel do cluster ao vivo no terminal

---

## yby access

Estabelece conexões seguras (port-forward) para os serviços disponíveis:
- Argo CD
- MinIO (se detectado)
- Prometheus (para alimentar Grafana)
- Grafana Local (via Docker)
- Headlamp (Token)

Você pode especificar um contexto (local/prod) com --context.

**Uso**

```
yby access [flags]
```

**Exemplos**

```bash
yby access
yby access --context prod
# Abre túnel para o ArgoCD
yby access --context local
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Nome do contexto Kubernetes |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby atlas

Mapa da topologia da infraestrutura em diagramas Mermaid, refinados pela IA

**Uso**

```
yby atlas [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby bard

Assistente de IA do cluster: conversa, ferramentas e diagnóstico

**Uso**

```
yby bard [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby bootstrap

Grupo de comandos para inicializar a infraestrutura.

Disponível:
  yby bootstrap vps      - Provisiona um servidor Linux do zero (K3s, Docker, Firewall)
  yby bootstrap cluster  - Instala a stack GitOps (ArgoCD, Workflows) no cluster conectado

**Uso**

```
yby bootstrap <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby bootstrap cluster](#yby-bootstrap-cluster) — Instala a stack GitOps (ArgoCD, Workflows) no cluster conectado
* [yby bootstrap vps](#yby-bootstrap-vps) — Provisiona um VPS com K3s e prepara para GitOps

---

## yby bootstrap cluster

Executa o bootstrap completo do cluster, instalando:
1. Argo CD, Argo Workflows e Argo Events (Infraestrutura)
2. System Charts (CRDs, Cert-Manager, Monitoring)
3. Configuração de Secrets (Git Credentials, Tokens)
4. Aplicação Root (App of Apps) para início do GitOps
5. Versions são lidas de .yby/blueprint.yaml se disponível.

**Uso**

```
yby bootstrap cluster [flags]
```

**Exemplos**

```bash
# Bootstrap padrão (lê variáveis GITHUB_REPO e TOKEN do ambiente)
yby bootstrap cluster

# Forçar uso do blueprint para versões
yby bootstrap cluster --context prod
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby bootstrap vps

Conecta via SSH a um servidor VPS (definido no .env) ou executa localmente.
Instala dependências, configura firewall, instala K3s e configura o kubeconfig local.

Pré-requisitos (verificados automaticamente):
* Ubuntu 22.04+ (Recomendado)
* 4GB RAM (Mínimo recomendado para stack completa)
* Acesso root/sudo

**Uso**

```
yby bootstrap vps [flags]
```

**Exemplos**

```bash
# Provisionar VPS remoto (requer acesso SSH por chave)
yby bootstrap vps --host 192.168.1.10 --user ubuntu

# Provisionar máquina local (laptop/desktop)
yby bootstrap vps --local
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--host texto` | IP ou Hostname do VPS |
| `--k3s-version texto` | Versão do K3s a ser instalada (padrão v1.31.2+k3s1) |
| `--local` | Executa o bootstrap na máquina local (auto-provisionamento) |
| `--port texto` | Porta SSH (padrão 22) |
| `--skip-tls-verify` | Desabilita verificação TLS do certificado do cluster (INSEGURO, usar apenas para debug) |
| `--user texto` | Usuário SSH (padrão root) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby chart

Utilitários para criar, validar e gerenciar Charts Helm seguindo os padrões do Yby.

**Uso**

```
yby chart <comando>
```

**Exemplos**

```bash
yby chart create my-service
yby chart create my-api --dir infra/charts
# Validar chart existente
yby chart validate charts/my-service
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby chart create](#yby-chart-create) — Cria um novo Helm Chart otimizado para a stack Yby

---

## yby chart create

Cria um novo Helm Chart otimizado para a stack Yby

**Uso**

```
yby chart create [NAME] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud

Gerencia clusters em AWS, Azure e GCP

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby cloud audit](#yby-cloud-audit) — Visualiza log de auditoria de operações cloud
* [yby cloud connect](#yby-cloud-connect) — Conecta a um cluster K8s em um provedor cloud
* [yby cloud dashboard](#yby-cloud-dashboard) — Painel dos clusters cloud, com a validade dos tokens
* [yby cloud list](#yby-cloud-list) — Lista clusters K8s disponíveis nos provedores cloud
* [yby cloud refresh](#yby-cloud-refresh) — Renova tokens de autenticação dos provedores cloud
* [yby cloud status](#yby-cloud-status) — Exibe o status de credenciais dos provedores cloud

---

## yby cloud audit

Visualiza log de auditoria de operações cloud

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud audit [flags]
```

**Exemplos**

```bash
yby cloud audit --since 2026-04-01 --provider aws
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--export texto` | Formato de exportação (json, csv) |
| `--provider texto` | Filtrar por provider (aws, azure, gcp) |
| `--since texto` | Filtrar eventos desde data (formato: 2006-01-02) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud connect

Configura o kubeconfig local para acessar um cluster K8s gerenciado.

Modo interativo (sem flags): detecta provedores, lista clusters e guia a configuração.
Modo não-interativo: forneça --provider, --region e --cluster.

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud connect [flags]
```

**Exemplos**

```bash
# Modo interativo (guiado)
yby cloud connect

# Modo não-interativo
yby cloud connect --provider aws --region us-east-1 --cluster meu-cluster

# Com criação de ambiente
yby cloud connect --provider gcp --region us-central1 --cluster prod --env-name prod
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--cluster texto` | Nome do cluster |
| `--env-name texto` | Nome do ambiente a criar |
| `--provider texto` | Cloud provider (aws, azure, gcp) |
| `--region texto` | Região do cluster |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud dashboard

Painel dos clusters cloud, com a validade dos tokens

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud dashboard [flags]
```

**Exemplos**

```bash
yby cloud dashboard
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud list

Lista clusters K8s disponíveis nos provedores cloud

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud list [flags]
```

**Exemplos**

```bash
yby cloud list
yby cloud list --provider aws
yby cloud list --provider gcp --region us-central1
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--provider texto` | Filtrar por provider (aws, azure, gcp) |
| `--region texto` | Filtrar por região |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud refresh

Renova tokens de autenticação dos provedores cloud

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud refresh [flags]
```

**Exemplos**

```bash
yby cloud refresh
yby cloud refresh --provider aws
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--provider texto` | Filtrar por provider (aws, azure, gcp) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby cloud status

Exibe o status de credenciais dos provedores cloud

Beta: testado com os CLIs aws, az e gcloud e conferido contra a documentação oficial, mas ainda não contra clusters reais. Login, tokens e kubeconfig podem falhar de jeitos que os testes não pegaram; relate em github.com/casheiro/yby-cli/issues.

**Uso**

```
yby cloud status [flags]
```

**Exemplos**

```bash
yby cloud status
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby completion

Para carregar as completions em sua sessão de shell atual:

Bash:
  $ source <(yby completion bash)

Zsh:
  * Se o autocompletion shell não estiver ativado adicione a seu .zshrc:
  > autoload -U compinit; compinit
  $ source <(yby completion zsh)

Fish:
  $ yby completion fish | source

PowerShell:
  PS> yby completion powershell | Out-String | Invoke-Expression

**Uso**

```
yby completion [bash|zsh|fish|powershell]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby destroy

Remove o cluster Yby e limpa recursos associados.
ATENÇÃO: Este comando é destrutivo e removerá o cluster criado pelo 'yby up'.
Para ambientes não-locais (dev/staging/prod), o cluster k3d vem de YBY_CLUSTER_NAME
(sem ela, o comando recusa em vez de apagar o cluster local) e exige a flag
--yes-destroy-production e confirmação interativa digitando o nome do cluster.

**Uso**

```
yby destroy [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--yes-destroy-production` | Confirma destruição de ambientes não-locais (requerido para dev/staging/prod) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby doctor

Verifica se as ferramentas necessárias (kubectl, helm, kubeseal) estão instaladas
e se há conexão com o cluster Kubernetes configurado.

**Uso**

```
yby doctor [flags]
```

**Exemplos**

```bash
yby doctor
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env

Gerencia ambientes e contextos (dev, staging, prod)

**Uso**

```
yby env <comando>
```

**Apelidos:** `context`

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby env check](#yby-env-check) — Valida integridade dos ambientes configurados
* [yby env create](#yby-env-create) — Cria um novo ambiente e gera values correspondente
* [yby env dump](#yby-env-dump) — Exibe o contexto atual e variáveis carregadas
* [yby env list](#yby-env-list) — Lista os ambientes disponíveis
* [yby env show](#yby-env-show) — Mostra detalhes do ambiente atual
* [yby env use](#yby-env-use) — Define o ambiente ativo

---

## yby env check

Valida integridade dos ambientes configurados

**Uso**

```
yby env check [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env create

Cria um novo ambiente e gera values correspondente

**Uso**

```
yby env create [name] [flags]
```

**Exemplos**

```bash
yby env create qa --type remote --description "Quality Assurance"
# Cria config/values-qa.yaml e adiciona entry em .yby/environments.yaml
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--cloud-cluster texto` | Nome do cluster cloud |
| `--cloud-provider texto` | Cloud provider (aws, azure, gcp) |
| `--cloud-region texto` | Região do cloud provider |
| `--description texto` | Descrição do ambiente |
| `--kube-context texto` | Contexto kubectl associado ao ambiente |
| `--namespace texto` | Namespace padrão do ambiente |
| `--type texto` | Tipo do ambiente (local/remote) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env dump

Mostra as variáveis de ambiente que foram injetadas pelo Motor de Contextos.
Útil para debugar se o .env correto está sendo carregado.

**Uso**

```
yby env dump [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env list

Lista os ambientes disponíveis

**Uso**

```
yby env list [flags]
```

**Exemplos**

```bash
yby env list
# Lista ambiente, tipo e descrição; o ambiente ativo vem marcado
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env show

Mostra detalhes do ambiente atual

**Uso**

```
yby env show [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby env use

Define o ambiente ativo

**Uso**

```
yby env use [name] [flags]
```

**Exemplos**

```bash
yby env use prod
# Atualiza automaticamente o contexto do kubectl e helm
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby generate

Utilitário para gerar manifestos Kubernetes e outros recursos.

**Uso**

```
yby generate <comando>
```

**Apelidos:** `gen`

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby generate keda](#yby-generate-keda) — Gerar um KEDA ScaledObject (Cron)

---

## yby generate keda

Gerar um KEDA ScaledObject (Cron)

**Uso**

```
yby generate keda [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--deployment texto` | Nome do Deployment |
| `--end-schedule texto` | Cron schedule para desligar o scaler (padrão: 08:00 diário) (padrão 0 8 * * *) |
| `--name texto` | Nome do ScaledObject |
| `--namespace texto` | Namespace |
| `--replicas texto` | Máximo de réplicas ao ligar (padrão 1) |
| `--schedule texto` | Cron de início (desligar) (padrão 0 20 * * *) |
| `--timezone texto` | Timezone (padrão America/Sao_Paulo) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby init

Gera a estrutura inicial do projeto (Charts, Manifests, Workflows) baseada em padrões.
Suporta execução interativa (Wizard) ou Headless (Flags).

**Uso**

```
yby init [flags]
```

**Exemplos**

```bash
# Modo Interativo (Wizard)
yby init

# Modo Headless (CI/CD ou Scripts)
yby init --project-name meu-app --git-repo https://github.com/org/repo.git --topology standard --workflow gitflow --target-dir infra

# AI-Native Initialization
yby init --description "A secure payment gateway for crypto assets"
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--ai-provider texto` | Forçar provedor de IA específico (ollama, gemini, openai) |
| `--config texto` | Arquivo de configuração enterprise (.yby/overrides.yaml) |
| `--description texto` | Descrição em linguagem natural do projeto (Habilita geração por IA) |
| `--domain texto` | Domínio base do cluster (padrão yby.local) |
| `--email texto` | Email do admin (padrão admin@yby.local) |
| `--enable-keda` | Habilitar módulo KEDA |
| `--enable-kepler` | Habilitar módulo Kepler |
| `--enable-metrics-server` | Habilitar Metrics Server (Observability) |
| `--enable-minio` | Habilitar módulo MinIO |
| `--env texto` | Nome do ambiente inicial (padrão dev) |
| `--environments texto` | Lista de ambientes separados por vírgula (ex: local,dev,hom,prod). Sobrescreve os ambientes padrão da topologia |
| `--force` | Sobrescrever projeto existente sem confirmação |
| `--git-branch texto` | Branch principal do git (padrão main) |
| `--git-repo texto` | URL do Repositório Git |
| `--include-ci` | Habilitar geração de CI/CD (padrão true) |
| `--include-devcontainer` | Gerar configuração .devcontainer |
| `--non-interactive` | Modo Não-Interativo: Falha se argumentos obrigatórios estiverem faltando (Ideal para VPS/CI) |
| `--offline` | Modo offline: pula as verificações do Git remoto e usa os padrões locais |
| `--project-name texto` | Nome do Projeto/Slug (Sobrescreve derivação padrão) |
| `--secrets-strategy texto` | Estratégia de secrets: sealed-secrets, external-secrets, sops (padrão external-secrets) |
| `-t, --target-dir texto` | Diretório alvo para inicialização do projeto |
| `--topology texto` | Estratégia de Topologia: single, standard, complete |
| `--update` | Atualiza scaffold preservando alterações do usuário |
| `--workflow texto` | Padrão de Workflow: essential, gitflow, trunkbased |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby logs

Exibe ou acompanha logs de pods Kubernetes.

Sem argumentos, apresenta uma seleção interativa de pods.
Com argumento, detecta automaticamente o namespace do pod.

Exemplos:
  yby logs                          # Seleção interativa
  yby logs nginx-abc123             # Auto-detect namespace
  yby logs nginx-abc123 -f          # Acompanhar logs (follow)
  yby logs nginx-abc123 -t 100      # Últimas 100 linhas
  yby logs nginx-abc123 --container sidecar  # Container específico

**Uso**

```
yby logs [pod] [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--container texto` | Nome do container (para pods multi-container) |
| `-f, --follow` | Acompanhar logs em tempo real |
| `-t, --tail n` | Número de linhas do final (0 = todas) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin

Lista, instala e gerencia plugins que estendem as funcionalidades da CLI.

**Uso**

```
yby plugin <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby plugin install](#yby-plugin-install) — Instala um plugin a partir de um arquivo local ou nome (atlas, bard, sentinel)
* [yby plugin list](#yby-plugin-list) — Lista plugins instalados
* [yby plugin remove](#yby-plugin-remove) — Remove um plugin instalado
* [yby plugin trust](#yby-plugin-trust) — Registra um plugin, ou uma ferramenta ou prompt do projeto, como confiável
* [yby plugin untrust](#yby-plugin-untrust) — Remove um plugin, ou uma ferramenta ou prompt do projeto, da whitelist de confiança
* [yby plugin update](#yby-plugin-update) — Atualiza um ou todos os plugins instalados

---

## yby plugin install

Instala um plugin a partir de um arquivo local ou nome (atlas, bard, sentinel)

**Uso**

```
yby plugin install [path|name] [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `-f, --force` | Forçar reinstalação se já existir |
| `--version texto` | Versão específica para instalar (ex: v1.0.0) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin list

Lista plugins instalados

**Uso**

```
yby plugin list [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin remove

Remove um plugin instalado

**Uso**

```
yby plugin remove [name] [flags]
```

**Apelidos:** `rm`, `uninstall`, `delete`

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin trust

Calcula o SHA256 do binário do plugin e o registra como confiável. Plugins não registrados não podem ser executados.

Com um arquivo do projeto (.yby/tools/*.yaml, as ferramentas do Bard, ou .yby/prompts/*.txt), registra o SHA256 do arquivo naquele caminho: sem isso, o yby não o usa, porque um repositório clonado pode trazê-lo. Se o arquivo mudar, a confiança cai e é preciso confirmar de novo.

**Uso**

```
yby plugin trust [name|arquivo] [flags]
```

**Exemplos**

```bash
yby plugin trust sentinel
yby plugin trust .yby/tools/backup.yaml
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin untrust

Remove um plugin, ou uma ferramenta ou prompt do projeto, da whitelist de confiança

**Uso**

```
yby plugin untrust [name|arquivo] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby plugin update

Atualiza um ou todos os plugins instalados

**Uso**

```
yby plugin update [name] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret

Agrupa utilitários para gerar e gerenciar segredos.

**Uso**

```
yby secret <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby secret backup](#yby-secret-backup) — Backup da chave mestre do Sealed Secrets
* [yby secret github-token](#yby-secret-github-token) — Cria secret para Discovery (GitHub Token)
* [yby secret init-eso](#yby-secret-init-eso) — Gera scaffold do SecretStore para External Secrets Operator
* [yby secret init-sops](#yby-secret-init-sops) — Inicializa SOPS + age para o projeto
* [yby secret minio](#yby-secret-minio) — Gera Sealed Secret do MinIO
* [yby secret restore](#yby-secret-restore) — Restaura chave mestre do Sealed Secrets
* [yby secret rotate](#yby-secret-rotate) — Rotaciona a chave de encriptação do Sealed Secrets
* [yby secret seal](#yby-secret-seal) — Cria e encripta um Kubernetes Secret (SealedSecret ou SOPS)
* [yby secret webhook](#yby-secret-webhook) — Gera ou exibe segredo do Webhook

---

## yby secret backup

Faz backup da chave privada do Sealed Secrets (cuidado!).
Salva em: bootstrap/sealed-secrets-backup.yaml (padrão) ou no caminho especificado.

**Uso**

```
yby secret backup [file] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret github-token

Cria o secret 'github-token' no namespace 'argocd' com o PAT do GitHub.
Necessário para o ApplicationSet descobrir repositórios.

**Uso**

```
yby secret github-token [token] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret init-eso

Gera o YAML de ClusterSecretStore para o backend especificado.
Use com --backend: vault, aws, gcp, azure

**Uso**

```
yby secret init-eso [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--backend texto` | Backend ESO: vault, aws, gcp, azure |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret init-sops

Gera um par de chaves age e exibe a chave pública para configurar .sops.yaml.
A chave privada é salva localmente e NUNCA deve ir para o Git.

**Uso**

```
yby secret init-sops [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret minio

Gera credenciais aleatórias para o MinIO, cria o Secret e sela.
Salva em: charts/system/templates/secrets/sealed-secret-minio.yaml

**Uso**

```
yby secret minio [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret restore

Aplica um backup de chave mestre e reinicia o controller.
Arquivo padrão: bootstrap/sealed-secrets-backup.yaml

**Uso**

```
yby secret restore [file] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret rotate

Remove a chave ativa atual do Sealed Secrets e reinicia o controller,
forçando a geração de uma nova chave de encriptação.

IMPORTANTE: Faça backup da chave atual antes de rotacionar!
  yby secret backup

Após a rotação, todos os SealedSecrets existentes continuam funcionando
(o controller mantém chaves antigas para decriptação), mas novos secrets
serão selados com a nova chave.

A flag --schedule é apenas informativa para documentar a política de rotação
recomendada (ex: --schedule "0 0 1 */3 *" para rotação trimestral).
O agendamento real deve ser configurado via CronJob no cluster ou pipeline CI.

**Uso**

```
yby secret rotate [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--schedule texto` | Expressão cron para documentar política de rotação (ex: "0 0 1 */3 *") |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret seal

Helper interativo para criar secrets encriptados.
Coleta nome, namespace e dados, gera um Secret Kubernetes e encripta
usando a estratégia configurada (sealed-secrets ou sops).

**Uso**

```
yby secret seal [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--strategy texto` | Estrategia de encriptacao: sealed-secrets, sops (padrão sealed-secrets) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby secret webhook

Cria um SealedSecret para o Webhook (ex: GitHub).
Uso: yby secret webhook github [my-secret-value]
Se o valor não for fornecido, gera um aleatório.
Salva em: charts/cluster-config/templates/events/sealed-secret-github.yaml

**Uso**

```
yby secret webhook [provider] [secret] [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby sentinel

Auditoria de segurança K8s com scan de vulnerabilidades e investigação por IA

**Uso**

```
yby sentinel [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby setup

Verifica e auxilia na instalação das dependências necessárias para
rodar o ambiente de desenvolvimento localmente (kubectl, helm, k3d, direnv).

Exemplo:
  yby setup

**Uso**

```
yby setup [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--profile texto` | Perfil de configuração: 'dev' (completo) ou 'server' (operações básicas) (padrão dev) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby status

Exibe informações sobre os nós do cluster, pods do Argo CD e Ingresses configurados.
Equivalente ao antigo 'make status'.

**Uso**

```
yby status [flags]
```

**Exemplos**

```bash
yby status
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby synapstor

Gestão de conhecimento do projeto: UKIs, busca semântica, nota de qualidade e exportação

**Uso**

```
yby synapstor [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby telemetry

Gerencia dados de telemetria do Yby CLI

**Uso**

```
yby telemetry <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby telemetry export](#yby-telemetry-export) — Exporta dados de telemetria coletados (formato JSONL)

---

## yby telemetry export

Exporta dados de telemetria coletados (formato JSONL)

**Uso**

```
yby telemetry export [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby uki

O comando UKI permite interagir com a camada de governança do Synapstor.
Use 'capture' para transformar intenções e descrições em documentação estruturada assistida por IA.

**Uso**

```
yby uki <comando>
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

**Comandos**

* [yby uki capture](#yby-uki-capture) — Captura conhecimento e gera arquivos UKI via IA

---

## yby uki capture

Analisa uma descrição em linguagem natural e gera artefatos de governança (Markdown)
dentro do diretório .synapstor/.uki/.

Exemplo:
  yby uki capture "Precisamos de uma política de retenção de logs de 30 dias para compliance PCI-DSS"
  yby uki capture --file minutas/reuniao-seguranca.txt

**Uso**

```
yby uki capture [description] [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--ai-provider texto` | Forçar provedor de IA (ollama, gemini, openai) |
| `--file texto` | Arquivo de texto para capturar como UKI |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby uninstall

Remove o binário do Yby CLI do sistema.
Esta ação é irreversível e removerá apenas o executável atual.
Arquivos de configuração e dados em ~/.yby não serão removidos automaticamente.

**Uso**

```
yby uninstall [flags]
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `-y, --yes` | Remove sem perguntar (para scripts e terminais não interativos) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby up

O comando 'up' coloca o ambiente no estado desejado.

Comportamento por Ambiente:
  - local: Inicia cluster (se necessário), configura Git Mirror, cria Túnel de Sync e mantém sincronização automática.
  - dev/staging/prod: Verifica acesso ao cluster e estado do GitOps. NÃO inicia sincronização local (use 'git push').

**Uso**

```
yby up [flags]
```

**Apelidos:** `dev`

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--plain-secrets` | Usa secrets simples (não encriptados) no ambiente local. Evita problemas ao recriar clusters. |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby upgrade

Verifica e instala a versão mais recente do Yby CLI.

Busca o último release no GitHub, verifica o checksum SHA256
e substitui o binário atual.

**Uso**

```
yby upgrade [flags]
```

**Exemplos**

```bash
yby upgrade --check
yby upgrade
yby upgrade --version v0.6.0
```

**Flags**

| Flag | Descrição |
| :--- | :--- |
| `--check` | Apenas verificar se há atualização disponível |
| `--force` | Forçar atualização mesmo se já estiver na versão mais recente |
| `--version texto` | Versão específica para instalar (ex: v0.6.0) |

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby validate

Executa linting e renderização de templates (dry-run) para garantir
que os charts Helm estão válidos antes do commit.

Equivalente ao antigo 'make validate'.

**Uso**

```
yby validate [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby version

Mostra a versão atual, hash do commit, data de build e informações do sistema.

**Uso**

```
yby version [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---

## yby viz

Painel do cluster ao vivo no terminal

**Uso**

```
yby viz [flags]
```

**Flags globais**

| Flag | Descrição |
| :--- | :--- |
| `-c, --context texto` | Define o contexto de execução (ex: local, staging, prod) |
| `--log-format texto` | Formato de log (text, json) (padrão text) |
| `--log-level texto` | Nível de log (debug, info, warn, error) (padrão info) |

---