Files
crewAI/docs/edge/pt-BR/installation.mdx
Lucas Gomide a237ebabba feat: adopt directory-based docs versioning with Edge channel (#6202)
* feat: adopt directory-based docs versioning with Edge channel

Switch docs.crewai.com from navigation-only versioning (every version
selector entry rendered the same docs/<lang>/* source files) to
Mintlify's directory-based versioning so each version selector entry
renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/*
that always reflects main HEAD for unreleased work, eliminating
pre-release leakage onto frozen release labels. External links to
canonical /<lang>/* URLs are preserved via wildcard redirects that
always land on the current default version.

Layout:
- docs/edge/<lang>/*         rolling source (you edit here)
- docs/edge/enterprise-api.*.yaml
- docs/v<X.Y.Z>/<lang>/*     frozen, immutable snapshots
- docs/v<X.Y.Z>/enterprise-api.*.yaml
- docs/images/               shared, append-only
- docs/docs.json             nav + redirects

URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for
Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard
redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links
working, and every freeze rewrites them (plus all per-section/per-page
redirects) so destinations always resolve to the current default
without depending on a second redirect hop.

Release flow integration (devtools release):
- New module crewai_devtools.docs_versioning.freeze() materialises
  docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the
  snapshot, inserts the version into every language block in
  docs.json, and refreshes all redirect destinations.
- _update_docs_and_create_pr() in cli.py now calls that freeze during
  Phase 2 of devtools release. Edge changelogs are updated first (so
  the snapshot freeze picks them up), then the snapshot is staged
  alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR
  is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z>
  — the title prefix the new CI guard reads.
- The PR still gates tag, GitHub release, PyPI publish, and the
  enterprise release as before; no new PRs are added.
- Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride
  Edge — and the docs PR title omits the [docs-freeze] prefix.
- docs_check (AI-generated docs scaffolding) writes to
  docs/edge/<lang>/* so newly-generated unreleased docs land in Edge
  and never accidentally touch a frozen snapshot.

Migration scripts (one-shot):
- scripts/docs/freeze_historical_versions.py reconstructs all 16
  historical snapshots (v1.10.0 .. v1.14.7) from git tags via
  git archive | tar, rewriting openapi: MDX refs so each snapshot
  reads its own enterprise-api YAML rather than the live one.
- scripts/docs/prefix_version_paths.py one-shot-migrates docs.json:
  rewrites every page path in 16 versioned blocks to point under
  docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags
  v1.14.7 as Latest (default), prunes pages whose target file
  doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before
  v1.12.0), and writes the wildcard + per-section redirects.
- scripts/docs/freeze_current_edge.py is now a thin CLI wrapper
  around docs_versioning.freeze for manual one-off freezes (e.g.
  retroactively snapshotting a forgotten release).

CI guards (.github/workflows/docs-snapshots.yml):
- Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose
  title contains [docs-freeze] (i.e. release-cut PRs generated by
  devtools release or the manual wrapper) may modify them.
- Images under docs/images/ are append-only since snapshots share a
  single image directory. Deleting or renaming an image breaks every
  historical snapshot that still references it.

Restored docs/images/crewai-otel-export.png from PR #3673; it was
deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference
it. Restoring instead of editing the snapshots preserves historical
rendering fidelity and validates the new append-only rule
retroactively.

Tests:
- lib/devtools/tests/test_docs_versioning.py covers the freeze: file
  copy, openapi rewrite, version insertion, default demotion, redirect
  upserts, per-section redirect rewriting, idempotency, and invalid
  inputs.

Verified locally with mintlify broken-links: 0 broken links across
the full site (Edge + 16 frozen versions, 4 locales).

AGENTS.md (repo root) is the contributor guide for the new model;
RELEASING.md is the release-cut runbook; README's Contribution
section links to both.

Co-authored-by: Cursor <cursoragent@cursor.com>

* style: resolve linter issues

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-17 11:56:59 -04:00

217 lines
7.2 KiB
Plaintext

---
title: Instalação
description: Comece a usar o CrewAI - Instale, configure e crie seu primeiro crew de IA
icon: wrench
mode: "wide"
---
### Assista: Construindo Agents e Flows CrewAI com Coding Agent Skills
Instale nossas coding agent skills (Claude Code, Codex, ...) para colocar seus agentes de código para funcionar rapidamente com o CrewAI.
Você pode instalar com `npx skills add crewaiinc/skills`
<iframe src="https://www.loom.com/embed/befb9f68b81f42ad8112bfdd95a780af" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{width: "100%", height: "400px"}}></iframe>
## Tutorial em Vídeo
Assista a este tutorial em vídeo para uma demonstração passo a passo do processo de instalação:
<iframe
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/-kSOTtYzgEw"
title="CrewAI Installation Guide"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>
## Tutorial em Texto
<Note>
**Requisitos de Versão do Python**
CrewAI requer `Python >=3.10 e <3.14`. Veja como verificar sua versão:
```bash
python3 --version
```
Se você precisar atualizar o Python, acesse [python.org/downloads](https://python.org/downloads)
</Note>
CrewAI utiliza o `uv` como ferramenta de gerenciamento de dependências e pacotes. Ele simplifica a configuração e execução do projeto, oferecendo uma experiência fluida.
Se você ainda não instalou o `uv`, siga o **passo 1** para instalá-lo rapidamente em seu sistema, caso contrário, avance para o **passo 2**.
<Steps>
<Step title="Instale o uv">
- **No macOS/Linux:**
Use `curl` para baixar o script e executá-lo com `sh`:
```shell
curl -LsSf https://astral.sh/uv/install.sh | sh
```
Se seu sistema não possuir `curl`, você pode usar `wget`:
```shell
wget -qO- https://astral.sh/uv/install.sh | sh
```
- **No Windows:**
Use `irm` para baixar o script e `iex` para executá-lo:
```shell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Caso enfrente algum problema, consulte o [guia de instalação do UV](https://docs.astral.sh/uv/getting-started/installation/) para mais informações.
</Step>
<Step title="Instale o CrewAI 🚀">
- Execute o seguinte comando para instalar o CLI do `crewai`:
```shell
uv tool install crewai
```
<Warning>
Se aparecer um aviso relacionado ao `PATH`, execute este comando para atualizar seu shell:
```shell
uv tool update-shell
```
</Warning>
<Warning>
Se você encontrar o erro de build ao instalar `chroma-hnswlib==0.7.6` (`fatal error C1083: Cannot open include file: 'float.h'`) no Windows, instale o (Visual Studio Build Tools)[https://visualstudio.microsoft.com/downloads/] com o *Desenvolvimento de Desktop com C++*.
</Warning>
- Para verificar se o `crewai` está instalado, execute:
```shell
uv tool list
```
- Você deverá ver algo assim:
```shell
crewai v0.102.0
- crewai
```
- Caso precise atualizar o `crewai`, execute:
```shell
uv tool install crewai --upgrade
```
<Check>Instalação realizada com sucesso! Você está pronto para criar seu primeiro crew! 🎉</Check>
</Step>
</Steps>
# Criando um Projeto CrewAI
`crewai create crew` agora cria um projeto de crew JSON-first. Os agentes ficam em `agents/*.jsonc`, as tarefas e configurações da crew ficam em `crew.jsonc`, e `crewai run` carrega essa definição JSON diretamente.
<Steps>
<Step title="Gerar Scaffolding do Projeto">
- Execute o comando CLI do `crewai`:
```shell
crewai create crew <your_project_name>
```
- Isso criará um novo projeto com a seguinte estrutura:
<Frame>
```
my_project/
├── .gitignore
├── .env
├── agents/
│ └── researcher.jsonc
├── crew.jsonc
├── knowledge/
├── pyproject.toml
├── README.md
├── skills/
└── tools/
```
</Frame>
- Se você precisar do scaffold antigo em Python/YAML com `crew.py`, `config/agents.yaml` e `config/tasks.yaml`, execute:
```shell
crewai create crew <your_project_name> --classic
```
</Step>
<Step title="Personalize Seu Projeto">
- Seu projeto conterá estes arquivos essenciais:
| Arquivo | Finalidade |
| --- | --- |
| `crew.jsonc` | Configure a crew, a ordem das tarefas, o processo e os inputs padrão |
| `agents/*.jsonc` | Defina o papel, objetivo, backstory, LLM, ferramentas e comportamento de cada agente |
| `.env` | Armazene chaves de API e variáveis de ambiente |
| `tools/` | Arquivos Python opcionais para ferramentas `custom:<name>` |
| `knowledge/` | Arquivos opcionais de conhecimento para agentes |
| `skills/` | Arquivos opcionais de skills aplicadas à crew |
- Comece editando `crew.jsonc` e os arquivos em `agents/` para definir o comportamento da crew.
- Use valores `{placeholder}` nos textos de agentes e tarefas e defina padrões em `crew.jsonc` dentro de `inputs`. Ao executar `crewai run`, a CLI pergunta por valores que estiverem faltando.
- Mantenha informações sensíveis como chaves de API no arquivo `.env`.
</Step>
<Step title="Execute seu Crew">
- Antes de rodar seu crew, execute:
```bash
crewai install
```
- Se precisar instalar pacotes adicionais, utilize:
```shell
uv add <package-name>
```
- Para rodar seu crew, execute o seguinte comando na raiz do seu projeto:
```bash
crewai run
```
</Step>
</Steps>
## Opções de Instalação Enterprise
<Note type="info">
Para equipes e organizações, o CrewAI oferece opções de implantação corporativa que eliminam a complexidade da configuração:
### CrewAI AMP (SaaS)
- Zero instalação necessária - basta se cadastrar gratuitamente em [app.crewai.com](https://app.crewai.com)
- Atualizações e manutenção automáticas
- Infraestrutura e escalabilidade gerenciadas
- Construa crews sem código
### CrewAI Factory (Auto-Hospedado)
- Implantação containerizada para sua infraestrutura
- Compatível com qualquer hyperscaler, incluindo ambientes on-premises
- Integração com seus sistemas de segurança existentes
<Card title="Explore as Opções Enterprise" icon="building" href="https://share.hsforms.com/1Ooo2UViKQ22UOzdr7i77iwr87kg">
Saiba mais sobre as soluções enterprise do CrewAI e agende uma demonstração
</Card>
</Note>
## Próximos Passos
<CardGroup cols={2}>
<Card
title="Início rápido: Flow + agente"
icon="code"
href="/pt-BR/quickstart"
>
Siga o guia rápido para gerar um Flow, executar um crew com um agente e produzir um relatório.
</Card>
<Card
title="Junte-se à Comunidade"
icon="comments"
href="https://community.crewai.com"
>
Conecte-se com outros desenvolvedores, obtenha ajuda e compartilhe suas
experiências com o CrewAI.
</Card>
</CardGroup>