mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-22 07:15:10 +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>
155 lines
4.0 KiB
Plaintext
155 lines
4.0 KiB
Plaintext
---
|
|
title: Tool Repository
|
|
description: "Using the Tool Repository to manage your tools"
|
|
icon: "toolbox"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
The Tool Repository is a package manager for CrewAI tools. It allows users to publish, install, and manage tools that integrate with CrewAI crews and flows.
|
|
|
|
Tools can be:
|
|
|
|
- **Private**: accessible only within your organization (default)
|
|
- **Public**: accessible to all CrewAI users if published with the `--public` flag
|
|
|
|
The repository is not a version control system. Use Git to track code changes and enable collaboration.
|
|
|
|
## Prerequisites
|
|
|
|
Before using the Tool Repository, ensure you have:
|
|
|
|
- A [CrewAI AMP](https://app.crewai.com) account
|
|
- [CrewAI CLI](/en/concepts/cli#cli) installed
|
|
- uv>=0.5.0 installed. Check out [how to upgrade](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
|
|
- [Git](https://git-scm.com) installed and configured
|
|
- Access permissions to publish or install tools in your CrewAI AMP organization
|
|
|
|
## Installing Tools
|
|
|
|
To install a tool:
|
|
|
|
```bash
|
|
crewai tool install <tool-name>
|
|
```
|
|
|
|
This installs the tool and adds it to `pyproject.toml`.
|
|
|
|
You can use the tool by importing it and adding it to your agents:
|
|
|
|
```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
|
|
)
|
|
```
|
|
|
|
## Adding other packages after installing a tool
|
|
|
|
After installing a tool from the CrewAI AMP Tool Repository, you need to use the `crewai uv` command to add other packages to your project.
|
|
Using pure `uv` commands will fail due to authentication to tool repository being handled by the CLI. By using the `crewai uv` command, you can add other packages to your project without having to worry about authentication.
|
|
Any `uv` command can be used with the `crewai uv` command, making it a powerful tool for managing your project's dependencies without the hassle of managing authentication through environment variables or other methods.
|
|
|
|
Say that you have installed a custom tool from the CrewAI AMP Tool Repository called "my-tool":
|
|
|
|
```bash
|
|
crewai tool install my-tool
|
|
```
|
|
|
|
And now you want to add another package to your project, you can use the following command:
|
|
|
|
```bash
|
|
crewai uv add requests
|
|
```
|
|
|
|
Other commands like `uv sync` or `uv remove` can also be used with the `crewai uv` command:
|
|
|
|
```bash
|
|
crewai uv sync
|
|
```
|
|
|
|
```bash
|
|
crewai uv remove requests
|
|
```
|
|
|
|
This will add the package to your project and update `pyproject.toml` accordingly.
|
|
|
|
## Creating and Publishing Tools
|
|
|
|
To create a new tool project:
|
|
|
|
```bash
|
|
crewai tool create <tool-name>
|
|
```
|
|
|
|
This generates a scaffolded tool project locally.
|
|
|
|
After making changes, initialize a Git repository and commit the code:
|
|
|
|
```bash
|
|
git init
|
|
git add .
|
|
git commit -m "Initial version"
|
|
```
|
|
|
|
To publish the tool:
|
|
|
|
```bash
|
|
crewai tool publish
|
|
```
|
|
|
|
By default, tools are published as private. To make a tool public:
|
|
|
|
```bash
|
|
crewai tool publish --public
|
|
```
|
|
|
|
For more details on how to build tools, see [Creating your own tools](/en/concepts/tools#creating-your-own-tools).
|
|
|
|
## Updating Tools
|
|
|
|
To update a published tool:
|
|
|
|
1. Modify the tool locally
|
|
2. Update the version in `pyproject.toml` (e.g., from `0.1.0` to `0.1.1`)
|
|
3. Commit the changes and publish
|
|
|
|
```bash
|
|
git commit -m "Update version to 0.1.1"
|
|
crewai tool publish
|
|
```
|
|
|
|
## Deleting Tools
|
|
|
|
To delete a tool:
|
|
|
|
1. Go to [CrewAI AMP](https://app.crewai.com)
|
|
2. Navigate to **Tools**
|
|
3. Select the tool
|
|
4. Click **Delete**
|
|
|
|
<Warning>
|
|
Deletion is permanent. Deleted tools cannot be restored or re-installed.
|
|
</Warning>
|
|
|
|
## Security Checks
|
|
|
|
Every published version undergoes automated security checks, and are only available to install after they pass.
|
|
|
|
You can check the security check status of a tool at:
|
|
|
|
`CrewAI AMP > Tools > Your Tool > Versions`
|
|
|
|
<Card title="Need Help?" icon="headset" href="mailto:support@crewai.com">
|
|
Contact our support team for assistance with API integration or
|
|
troubleshooting.
|
|
</Card>
|