mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-28 10:09:21 +00:00
a237ebabba
* 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>
110 lines
3.1 KiB
Plaintext
110 lines
3.1 KiB
Plaintext
---
|
|
title: Repositório de Ferramentas
|
|
description: "Usando o Repositório de Ferramentas para gerenciar suas ferramentas"
|
|
icon: "toolbox"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão geral
|
|
|
|
O Repositório de Ferramentas é um gerenciador de pacotes para ferramentas da CrewAI. Ele permite que usuários publiquem, instalem e gerenciem ferramentas que se integram com crews e flows da CrewAI.
|
|
|
|
As ferramentas podem ser:
|
|
|
|
- **Privadas**: acessíveis apenas dentro da sua organização (padrão)
|
|
- **Públicas**: acessíveis a todos os usuários CrewAI se publicadas com a flag `--public`
|
|
|
|
O repositório não é um sistema de controle de versões. Use Git para rastrear mudanças no código e permitir colaboração.
|
|
|
|
## Pré-requisitos
|
|
|
|
Antes de usar o Repositório de Ferramentas, certifique-se de que você possui:
|
|
|
|
- Uma conta [CrewAI AMP](https://app.crewai.com)
|
|
- [CrewAI CLI](/pt-BR/concepts/cli#cli) instalada
|
|
- uv>=0.5.0 instalado. Veja [como atualizar](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
|
|
- [Git](https://git-scm.com) instalado e configurado
|
|
- Permissões de acesso para publicar ou instalar ferramentas em sua organização CrewAI AMP
|
|
|
|
## Instalando ferramentas
|
|
|
|
Para instalar uma ferramenta:
|
|
|
|
```bash
|
|
crewai tool install <nome-da-ferramenta>
|
|
```
|
|
|
|
Isso instala a ferramenta e a adiciona ao `pyproject.toml`.
|
|
|
|
## Criando e publicando ferramentas
|
|
|
|
Para criar um novo projeto de ferramenta:
|
|
|
|
```bash
|
|
crewai tool create <nome-da-ferramenta>
|
|
```
|
|
|
|
Isso gera um projeto de ferramenta estruturado localmente.
|
|
|
|
Após fazer alterações, inicialize um repositório Git e faça o commit do código:
|
|
|
|
```bash
|
|
git init
|
|
git add .
|
|
git commit -m "Initial version"
|
|
```
|
|
|
|
Para publicar a ferramenta:
|
|
|
|
```bash
|
|
crewai tool publish
|
|
```
|
|
|
|
Por padrão, as ferramentas são publicadas como privadas. Para tornar uma ferramenta pública:
|
|
|
|
```bash
|
|
crewai tool publish --public
|
|
```
|
|
|
|
Para mais detalhes sobre como construir ferramentas, acesse [Criando suas próprias ferramentas](/pt-BR/concepts/tools#creating-your-own-tools).
|
|
|
|
## Atualizando ferramentas
|
|
|
|
Para atualizar uma ferramenta publicada:
|
|
|
|
1. Modifique a ferramenta localmente
|
|
2. Atualize a versão no `pyproject.toml` (por exemplo, de `0.1.0` para `0.1.1`)
|
|
3. Faça o commit das alterações e publique
|
|
|
|
```bash
|
|
git commit -m "Atualizar versão para 0.1.1"
|
|
crewai tool publish
|
|
```
|
|
|
|
## Excluindo ferramentas
|
|
|
|
Para excluir uma ferramenta:
|
|
|
|
1. Acesse o [CrewAI AMP](https://app.crewai.com)
|
|
2. Navegue até **Ferramentas**
|
|
3. Selecione a ferramenta
|
|
4. Clique em **Excluir**
|
|
|
|
<Warning>
|
|
A exclusão é permanente. Ferramentas excluídas não podem ser restauradas ou
|
|
reinstaladas.
|
|
</Warning>
|
|
|
|
## Verificações de segurança
|
|
|
|
Cada versão publicada passa por verificações automáticas de segurança e só fica disponível para instalação após aprovação.
|
|
|
|
Você pode verificar o status das verificações de segurança de uma ferramenta em:
|
|
|
|
`CrewAI AMP > Tools > Your Tool > Versions`
|
|
|
|
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para assistência com integração
|
|
de API ou resolução de problemas.
|
|
</Card>
|