mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-08 00:15:12 +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>
112 lines
3.1 KiB
Plaintext
112 lines
3.1 KiB
Plaintext
---
|
|
title: 도구 저장소
|
|
description: "도구 저장소를 사용하여 도구를 관리하기"
|
|
icon: "toolbox"
|
|
mode: "wide"
|
|
---
|
|
|
|
## 개요
|
|
|
|
Tool Repository는 CrewAI 도구를 위한 패키지 관리자입니다. 사용자는 CrewAI crew와 flow에 통합되는 도구를 게시, 설치 및 관리할 수 있습니다.
|
|
|
|
도구는 다음과 같이 분류됩니다:
|
|
|
|
- **비공개**: 조직 내에서만 접근할 수 있습니다(기본값)
|
|
- **공개**: `--public` 플래그로 게시하면 모든 CrewAI 사용자가 접근할 수 있습니다
|
|
|
|
이 저장소는 버전 관리 시스템이 아닙니다. 코드 변경 사항을 추적하고 협업을 활성화하려면 Git을 사용하십시오.
|
|
|
|
## 사전 요구 사항
|
|
|
|
Tool Repository를 사용하기 전에 다음이 준비되어 있어야 합니다:
|
|
|
|
- [CrewAI AMP](https://app.crewai.com) 계정
|
|
- [CrewAI CLI](/ko/concepts/cli#cli) 설치됨
|
|
- uv>=0.5.0 이 설치되어 있어야 합니다. [업그레이드 방법](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)을 참고하세요.
|
|
- [Git](https://git-scm.com) 설치 및 구성 완료
|
|
- CrewAI AMP 조직에서 도구를 게시하거나 설치할 수 있는 액세스 권한
|
|
|
|
## 도구 설치
|
|
|
|
도구를 설치하려면:
|
|
|
|
```bash
|
|
crewai tool install <tool-name>
|
|
```
|
|
|
|
이 명령은 도구를 설치하고 `pyproject.toml`에 추가합니다.
|
|
|
|
## 도구 생성 및 게시
|
|
|
|
새 도구 프로젝트를 생성하려면:
|
|
|
|
```bash
|
|
crewai tool create <tool-name>
|
|
```
|
|
|
|
이 명령은 로컬에 스캐폴딩된 도구 프로젝트를 생성합니다.
|
|
|
|
변경 사항을 적용한 후, Git 저장소를 초기화하고 코드를 커밋합니다:
|
|
|
|
```bash
|
|
git init
|
|
git add .
|
|
git commit -m "Initial version"
|
|
```
|
|
|
|
도구를 게시하려면:
|
|
|
|
```bash
|
|
crewai tool publish
|
|
```
|
|
|
|
기본적으로 도구는 비공개로 게시됩니다. 도구를 공개로 설정하려면:
|
|
|
|
```bash
|
|
crewai tool publish --public
|
|
```
|
|
|
|
도구 빌드에 대한 자세한 내용은 [나만의 도구 만들기](/ko/concepts/tools#creating-your-own-tools)를 참고하세요.
|
|
|
|
## 도구 업데이트
|
|
|
|
공개된 도구를 업데이트하려면:
|
|
|
|
1. 로컬에서 도구를 수정합니다.
|
|
2. `pyproject.toml`에서 버전을 업데이트합니다(예: `0.1.0`에서 `0.1.1`로).
|
|
3. 변경 사항을 커밋하고 배포합니다.
|
|
|
|
```bash
|
|
git commit -m "Update version to 0.1.1"
|
|
crewai tool publish
|
|
```
|
|
|
|
## 도구 삭제
|
|
|
|
도구를 삭제하려면:
|
|
|
|
1. [CrewAI AMP](https://app.crewai.com)로 이동합니다.
|
|
2. **Tools**로 이동합니다.
|
|
3. 도구를 선택합니다.
|
|
4. **Delete**를 클릭합니다.
|
|
|
|
<Warning>
|
|
삭제는 영구적입니다. 삭제된 도구는 복구하거나 다시 설치할 수 없습니다.
|
|
</Warning>
|
|
|
|
## 보안 점검
|
|
|
|
모든 공개된 버전은 자동화된 보안 점검을 거치며, 통과한 후에만 설치할 수 있습니다.
|
|
|
|
도구의 보안 점검 상태는 다음에서 확인할 수 있습니다:
|
|
|
|
`CrewAI AMP > Tools > Your Tool > Versions`
|
|
|
|
<Card
|
|
title="도움이 필요하신가요?"
|
|
icon="headset"
|
|
href="mailto:support@crewai.com"
|
|
>
|
|
API 통합 또는 문제 해결에 대한 지원이 필요하시면 지원팀에 문의해 주세요.
|
|
</Card>
|