mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-25 08:45:09 +00:00
* 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>
156 lines
4.5 KiB
Plaintext
156 lines
4.5 KiB
Plaintext
---
|
|
title: 'Agent Repositories'
|
|
description: 'Learn how to use Agent Repositories to share and reuse your agents across teams and projects'
|
|
icon: 'people-group'
|
|
mode: "wide"
|
|
---
|
|
|
|
Agent Repositories allow enterprise users to store, share, and reuse agent definitions across teams and projects. This feature enables organizations to maintain a centralized library of standardized agents, promoting consistency and reducing duplication of effort.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
## Benefits of Agent Repositories
|
|
|
|
- **Standardization**: Maintain consistent agent definitions across your organization
|
|
- **Reusability**: Create an agent once and use it in multiple crews and projects
|
|
- **Governance**: Implement organization-wide policies for agent configurations
|
|
- **Collaboration**: Enable teams to share and build upon each other's work
|
|
|
|
## Creating and Use Agent Repositories
|
|
|
|
1. You must have an account at CrewAI, try the [free plan](https://app.crewai.com).
|
|
2. Create agents with specific roles and goals for your workflows.
|
|
3. Configure tools and capabilities for each specialized assistant.
|
|
4. Deploy agents across projects via visual interface or API integration.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
|
|
### Loading Agents from Repositories
|
|
|
|
You can load agents from repositories in your code using the `from_repository` parameter to run locally:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
|
|
# Create an agent by loading it from a repository
|
|
# The agent is loaded with all its predefined configurations
|
|
researcher = Agent(
|
|
from_repository="market-research-agent"
|
|
)
|
|
```
|
|
|
|
### Overriding Repository Settings
|
|
|
|
You can override specific settings from the repository by providing them in the configuration:
|
|
|
|
```python
|
|
researcher = Agent(
|
|
from_repository="market-research-agent",
|
|
goal="Research the latest trends in AI development", # Override the repository goal
|
|
verbose=True # Add a setting not in the repository
|
|
)
|
|
```
|
|
|
|
### Example: Creating a Crew with Repository Agents
|
|
|
|
```python
|
|
from crewai import Crew, Agent, Task
|
|
|
|
# Load agents from repositories
|
|
researcher = Agent(
|
|
from_repository="market-research-agent"
|
|
)
|
|
|
|
writer = Agent(
|
|
from_repository="content-writer-agent"
|
|
)
|
|
|
|
# Create tasks
|
|
research_task = Task(
|
|
description="Research the latest trends in AI",
|
|
agent=researcher
|
|
)
|
|
|
|
writing_task = Task(
|
|
description="Write a comprehensive report based on the research",
|
|
agent=writer
|
|
)
|
|
|
|
# Create the crew
|
|
crew = Crew(
|
|
agents=[researcher, writer],
|
|
tasks=[research_task, writing_task],
|
|
verbose=True
|
|
)
|
|
|
|
# Run the crew
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### Example: Using `kickoff()` with Repository Agents
|
|
|
|
You can also use repository agents directly with the `kickoff()` method for simpler interactions:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from pydantic import BaseModel
|
|
from typing import List
|
|
|
|
# Define a structured output format
|
|
class MarketAnalysis(BaseModel):
|
|
key_trends: List[str]
|
|
opportunities: List[str]
|
|
recommendation: str
|
|
|
|
# Load an agent from repository
|
|
analyst = Agent(
|
|
from_repository="market-analyst-agent",
|
|
verbose=True
|
|
)
|
|
|
|
# Get a free-form response
|
|
result = analyst.kickoff("Analyze the AI market in 2025")
|
|
print(result.raw) # Access the raw response
|
|
|
|
# Get structured output
|
|
structured_result = analyst.kickoff(
|
|
"Provide a structured analysis of the AI market in 2025",
|
|
response_format=MarketAnalysis
|
|
)
|
|
|
|
# Access structured data
|
|
print(f"Key Trends: {structured_result.pydantic.key_trends}")
|
|
print(f"Recommendation: {structured_result.pydantic.recommendation}")
|
|
```
|
|
|
|
## Best Practices
|
|
|
|
1. **Naming Convention**: Use clear, descriptive names for your repository agents
|
|
2. **Documentation**: Include comprehensive descriptions for each agent
|
|
3. **Tool Management**: Ensure that tools referenced by repository agents are available in your environment
|
|
4. **Access Control**: Manage permissions to ensure only authorized team members can modify repository agents
|
|
|
|
## Organization Management
|
|
|
|
To switch between organizations or see your current organization, use the CrewAI CLI:
|
|
|
|
```bash
|
|
# View current organization
|
|
crewai org current
|
|
|
|
# Switch to a different organization
|
|
crewai org switch <org_id>
|
|
|
|
# List all available organizations
|
|
crewai org list
|
|
```
|
|
|
|
<Note>
|
|
When loading agents from repositories, you must be authenticated and switched to the correct organization. If you receive errors, check your authentication status and organization settings using the CLI commands above.
|
|
</Note>
|