mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-08 16:35:08 +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>
155 lines
4.9 KiB
Plaintext
155 lines
4.9 KiB
Plaintext
---
|
|
title: مستودع الأدوات
|
|
description: "استخدام مستودع الأدوات لإدارة أدواتك"
|
|
icon: "toolbox"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مستودع الأدوات هو مدير حزم لأدوات CrewAI. يتيح للمستخدمين نشر وتثبيت وإدارة الأدوات التي تتكامل مع طواقم وتدفقات CrewAI.
|
|
|
|
يمكن أن تكون الأدوات:
|
|
|
|
- **خاصة**: متاحة فقط داخل مؤسستك (افتراضي)
|
|
- **عامة**: متاحة لجميع مستخدمي CrewAI إذا نُشرت بعلامة `--public`
|
|
|
|
المستودع ليس نظام تحكم في الإصدارات. استخدم Git لتتبع تغييرات الكود وتمكين التعاون.
|
|
|
|
## المتطلبات المسبقة
|
|
|
|
قبل استخدام مستودع الأدوات، تأكد من أن لديك:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com)
|
|
- [CrewAI CLI](/ar/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`.
|
|
|
|
يمكنك استخدام الأداة باستيرادها وإضافتها إلى وكلائك:
|
|
|
|
```python
|
|
from your_tool.tool import YourTool
|
|
|
|
custom_tool = YourTool()
|
|
|
|
researcher = Agent(
|
|
role='Market Research Analyst',
|
|
goal='Provide up-to-date market analysis of the AI industry',
|
|
backstory='An expert analyst with a keen eye for market trends.',
|
|
tools=[custom_tool],
|
|
verbose=True
|
|
)
|
|
```
|
|
|
|
## إضافة حزم أخرى بعد تثبيت أداة
|
|
|
|
بعد تثبيت أداة من مستودع أدوات CrewAI AMP، تحتاج لاستخدام أمر `crewai uv` لإضافة حزم أخرى لمشروعك.
|
|
استخدام أوامر `uv` المباشرة سيفشل لأن المصادقة لمستودع الأدوات يتم التعامل معها عبر CLI. باستخدام أمر `crewai uv`، يمكنك إضافة حزم أخرى لمشروعك دون القلق بشأن المصادقة.
|
|
يمكن استخدام أي أمر `uv` مع أمر `crewai uv`، مما يجعله أداة قوية لإدارة اعتماديات مشروعك دون عناء إدارة المصادقة عبر متغيرات البيئة أو طرق أخرى.
|
|
|
|
لنفرض أنك ثبّت أداة مخصصة من مستودع أدوات CrewAI AMP تسمى "my-tool":
|
|
|
|
```bash
|
|
crewai tool install my-tool
|
|
```
|
|
|
|
والآن تريد إضافة حزمة أخرى لمشروعك، يمكنك استخدام الأمر التالي:
|
|
|
|
```bash
|
|
crewai uv add requests
|
|
```
|
|
|
|
أوامر أخرى مثل `uv sync` أو `uv remove` يمكن أيضاً استخدامها مع أمر `crewai uv`:
|
|
|
|
```bash
|
|
crewai uv sync
|
|
```
|
|
|
|
```bash
|
|
crewai uv remove requests
|
|
```
|
|
|
|
سيضيف هذا الحزمة لمشروعك ويحدّث `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
|
|
```
|
|
|
|
لمزيد من التفاصيل حول بناء الأدوات، راجع [إنشاء أدواتك الخاصة](/ar/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>
|