mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48: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>
240 lines
7.8 KiB
Plaintext
240 lines
7.8 KiB
Plaintext
---
|
|
title: Google Drive Integration
|
|
description: "File storage and management with Google Drive integration for CrewAI."
|
|
icon: "google"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Enable your agents to manage files and folders through Google Drive. Upload, download, organize, and share files, create folders, and streamline your document management workflows with AI-powered automation.
|
|
|
|
## Prerequisites
|
|
|
|
Before using the Google Drive integration, ensure you have:
|
|
|
|
- A [CrewAI AMP](https://app.crewai.com) account with an active subscription
|
|
- A Google account with Google Drive access
|
|
- Connected your Google account through the [Integrations page](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## Setting Up Google Drive Integration
|
|
|
|
### 1. Connect Your Google Account
|
|
|
|
1. Navigate to [CrewAI AMP Integrations](https://app.crewai.com/crewai_plus/connectors)
|
|
2. Find **Google Drive** in the Authentication Integrations section
|
|
3. Click **Connect** and complete the OAuth flow
|
|
4. Grant the necessary permissions for file and folder management
|
|
5. Copy your Enterprise Token from [Integration Settings](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. Install Required Package
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. Environment Variable Setup
|
|
|
|
<Note>
|
|
To use integrations with `Agent(apps=[])`, you must set the
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` environment variable with your Enterprise
|
|
Token.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
Or add it to your `.env` file:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## Available Actions
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="google_drive/get_file">
|
|
**Description:** Get a file by ID from Google Drive.
|
|
|
|
**Parameters:**
|
|
- `file_id` (string, required): The ID of the file to retrieve.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/list_files">
|
|
**Description:** List files in Google Drive.
|
|
|
|
**Parameters:**
|
|
- `q` (string, optional): Query string to filter files (example: "name contains 'report'").
|
|
- `page_size` (integer, optional): Maximum number of files to return (default: 100, max: 1000).
|
|
- `page_token` (string, optional): Token for retrieving the next page of results.
|
|
- `order_by` (string, optional): Sort order (example: "name", "createdTime desc", "modifiedTime").
|
|
- `spaces` (string, optional): Comma-separated list of spaces to query (drive, appDataFolder, photos).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/upload_file">
|
|
**Description:** Upload a file to Google Drive.
|
|
|
|
**Parameters:**
|
|
- `name` (string, required): Name of the file to create.
|
|
- `content` (string, required): Content of the file to upload.
|
|
- `mime_type` (string, optional): MIME type of the file (example: "text/plain", "application/pdf").
|
|
- `parent_folder_id` (string, optional): ID of the parent folder where the file should be created.
|
|
- `description` (string, optional): Description of the file.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/download_file">
|
|
**Description:** Download a file from Google Drive.
|
|
|
|
**Parameters:**
|
|
- `file_id` (string, required): The ID of the file to download.
|
|
- `mime_type` (string, optional): MIME type for export (required for Google Workspace documents).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/create_folder">
|
|
**Description:** Create a new folder in Google Drive.
|
|
|
|
**Parameters:**
|
|
- `name` (string, required): Name of the folder to create.
|
|
- `parent_folder_id` (string, optional): ID of the parent folder where the new folder should be created.
|
|
- `description` (string, optional): Description of the folder.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/delete_file">
|
|
**Description:** Delete a file from Google Drive.
|
|
|
|
**Parameters:**
|
|
- `file_id` (string, required): The ID of the file to delete.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/share_file">
|
|
**Description:** Share a file in Google Drive with specific users or make it public.
|
|
|
|
**Parameters:**
|
|
- `file_id` (string, required): The ID of the file to share.
|
|
- `role` (string, required): The role granted by this permission (reader, writer, commenter, owner).
|
|
- `type` (string, required): The type of the grantee (user, group, domain, anyone).
|
|
- `email_address` (string, optional): The email address of the user or group to share with (required for user/group types).
|
|
- `domain` (string, optional): The domain to share with (required for domain type).
|
|
- `send_notification_email` (boolean, optional): Whether to send a notification email (default: true).
|
|
- `email_message` (string, optional): A plain text custom message to include in the notification email.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/update_file">
|
|
**Description:** Update an existing file in Google Drive.
|
|
|
|
**Parameters:**
|
|
- `file_id` (string, required): The ID of the file to update.
|
|
- `name` (string, optional): New name for the file.
|
|
- `content` (string, optional): New content for the file.
|
|
- `mime_type` (string, optional): New MIME type for the file.
|
|
- `description` (string, optional): New description for the file.
|
|
- `add_parents` (string, optional): Comma-separated list of parent folder IDs to add.
|
|
- `remove_parents` (string, optional): Comma-separated list of parent folder IDs to remove.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Usage Examples
|
|
|
|
### Basic Google Drive Agent Setup
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Google Drive capabilities
|
|
drive_agent = Agent(
|
|
role="File Manager",
|
|
goal="Manage files and folders in Google Drive efficiently",
|
|
backstory="An AI assistant specialized in document and file management.",
|
|
apps=['google_drive'] # All Google Drive actions will be available
|
|
)
|
|
|
|
# Task to organize files
|
|
organize_files_task = Task(
|
|
description="List all files in the root directory and organize them into appropriate folders",
|
|
agent=drive_agent,
|
|
expected_output="Summary of files organized with folder structure"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[drive_agent],
|
|
tasks=[organize_files_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### Filtering Specific Google Drive Tools
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create agent with specific Google Drive actions only
|
|
file_manager_agent = Agent(
|
|
role="Document Manager",
|
|
goal="Upload and manage documents efficiently",
|
|
backstory="An AI assistant that focuses on document upload and organization.",
|
|
apps=[
|
|
'google_drive/upload_file',
|
|
'google_drive/create_folder',
|
|
'google_drive/share_file'
|
|
] # Specific Google Drive actions
|
|
)
|
|
|
|
# Task to upload and share documents
|
|
document_task = Task(
|
|
description="Upload the quarterly report and share it with the finance team",
|
|
agent=file_manager_agent,
|
|
expected_output="Document uploaded and sharing permissions configured"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_manager_agent],
|
|
tasks=[document_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### Advanced File Management
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
file_organizer = Agent(
|
|
role="File Organizer",
|
|
goal="Maintain organized file structure and manage permissions",
|
|
backstory="An experienced file manager who ensures proper organization and access control.",
|
|
apps=['google_drive']
|
|
)
|
|
|
|
# Complex task involving multiple Google Drive operations
|
|
organization_task = Task(
|
|
description="""
|
|
1. List all files in the shared folder
|
|
2. Create folders for different document types (Reports, Presentations, Spreadsheets)
|
|
3. Move files to appropriate folders based on their type
|
|
4. Set appropriate sharing permissions for each folder
|
|
5. Create a summary document of the organization changes
|
|
""",
|
|
agent=file_organizer,
|
|
expected_output="Files organized into categorized folders with proper permissions and summary report"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_organizer],
|
|
tasks=[organization_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|