Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions website/docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
sidebar_position: 3
title: Início Rápido
---

# Início Rápido (Quickstart)

Aprenda a instalar, executar sua primeira varredura e proteger seu repositório Git com o **`envguard`** em menos de 3 minutos.

---

## 1. Instalação Instantânea

Se você possui o Go instalado (1.22+):

```bash
go install github.com/joaooncode/envguard/cmd/envguard@latest
```

Ou no Windows com PowerShell:

```powershell
# Verifique a versão instalada
envguard version
```

> Para binários pré-compilados do Linux, macOS e Windows sem Go, consulte o [Guia de Instalação](./installation.md).

---

## 2. Execute sua Primeira Varredura

Navegue até a raiz do seu projeto com Git e execute o comando `scan`:

```bash
envguard scan
```

O `envguard` varrerá todos os arquivos e diretórios recursivamente, identificando arquivos de ambiente e cruzando o status com o Git e o `.gitignore`.

### Exemplo de Saída:

```text
[envguard] Iniciando varredura no repositório...

✗ .env CRITICAL Arquivo rastreado no Git (commitado)
⚠ .env.production WARNING Não ignorado no .gitignore
✓ .env.example INFO Template padrão identificado

Status: 2 problema(s) encontrado(s).
```

---

## 3. Gerar Arquivo de Configuração

Inicialize um arquivo `.envguard.yaml` para customizar permissões e regras do projeto:

```bash
envguard init
```

Isso gerará o arquivo de configuração `.envguard.yaml` na raiz do repositório:

```yaml
version: 1
patterns:
- '.env*'
ignore:
- '.env.example'
- '.env.template'
fail_on: 'warning' # Interrompe a execução com warning ou critical
```

---

## 4. Corrigir Problemas Automaticamente

Se o `envguard` detectar arquivos `.env` soltos que precisam ser adicionados ao `.gitignore` ou removidos do tracking do Git:

```bash
envguard fix
```

---

## 5. Instalar Git Hook Automático (Pre-Commit)

Garanta que nenhum arquivo de ambiente seja commitado por acidente instalando o hook nativo:

```bash
envguard hook install
```

Pronto! Toda vez que alguém executar `git commit`, o `envguard check` será executado automaticamente antes do commit ser gravado.

---

## Próximos Passos

- Explore todos os [Comandos da CLI](./commands/scan.md).
- Entenda a classificação dos [Níveis de Severidade](./severity-levels.md).
- Configure a integração com [GitHub Actions e CI/CD](./cicd-integration.md).
47 changes: 33 additions & 14 deletions website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,27 @@ const config: Config = {
],
],

themes: [
[
require.resolve('@easyops-cn/docusaurus-search-local'),
{
hashed: true,
language: ['en'],
indexDocs: true,
indexBlog: true,
indexPages: true,
docsRouteBasePath: '/docs',
highlightSearchTermsOnTargetPage: true,
searchResultLimits: 8,
searchResultContextMaxLength: 60,
},
],
],

themeConfig: {
image: 'img/docusaurus-social-card.jpg',
colorMode: {
defaultMode: 'dark',
respectPrefersColorScheme: true,
},
navbar: {
Expand All @@ -58,11 +76,12 @@ const config: Config = {
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
sidebarId: 'docsSidebar',
position: 'left',
label: 'Documentação',
},
{ to: '/blog', label: 'Blog / Notas de Versão', position: 'left' },
{ to: '/docs/quickstart', label: 'Início Rápido', position: 'left' },
{ to: '/blog', label: 'Blog & Versões', position: 'left' },
{
href: 'https://github.com/joaooncode/envguard',
label: 'GitHub',
Expand All @@ -74,29 +93,29 @@ const config: Config = {
style: 'dark',
links: [
{
title: 'Documentação',
title: 'Começando',
items: [
{ label: 'Visão Geral', to: '/docs/intro' },
{ label: 'Instalação', to: '/docs/installation' },
{ label: 'Comandos CLI', to: '/docs/commands/scan' },
{ label: 'Níveis de Severidade', to: '/docs/severity-levels' },
{ label: 'Início Rápido', to: '/docs/quickstart' },
],
},
{
title: 'Integrações',
title: 'Comandos & Regras',
items: [
{ label: 'CI/CD & Git Hooks', to: '/docs/cicd-integration' },
{ label: 'Guia de Contribuição', to: '/docs/contributing' },
{ label: 'Varredura (scan)', to: '/docs/commands/scan' },
{ label: 'Verificação (check)', to: '/docs/commands/check' },
{ label: 'Níveis de Severidade', to: '/docs/severity-levels' },
{ label: 'Configuração (.envguard.yaml)', to: '/docs/configuration' },
],
},
{
title: 'Comunidade',
title: 'Automação & Comunidade',
items: [
{ label: 'Repositório GitHub', href: 'https://github.com/joaooncode/envguard' },
{
label: 'Reportar Problema (Issue)',
href: 'https://github.com/joaooncode/envguard/issues',
},
{ label: 'CI/CD & Git Hooks', to: '/docs/cicd-integration' },
{ label: 'Guia de Contribuição', to: '/docs/contributing' },
{ label: 'GitHub Repository', href: 'https://github.com/joaooncode/envguard' },
{ label: 'Reportar Problema', href: 'https://github.com/joaooncode/envguard/issues' },
],
},
],
Expand Down
Loading
Loading