From 319a20c028fa65203212d54b76adadc795d9a74c Mon Sep 17 00:00:00 2001 From: Vidit Ostwal <110953813+Vidit-Ostwal@users.noreply.github.com> Date: Thu, 6 Aug 2026 01:10:19 +0530 Subject: [PATCH] docs: update scaffold AGENTS.md for unified create CLI (#6829) Document crewai create tool/skill/template, lifecycle commands, and deprecated-but-supported scaffolding aliases in the project template AGENTS.md. Remove the no-op --skip_provider flag from the flow example. --- lib/cli/src/crewai_cli/templates/AGENTS.md | 34 ++++++++++++++++++++-- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/lib/cli/src/crewai_cli/templates/AGENTS.md b/lib/cli/src/crewai_cli/templates/AGENTS.md index 6e99dbc96..f79784896 100644 --- a/lib/cli/src/crewai_cli/templates/AGENTS.md +++ b/lib/cli/src/crewai_cli/templates/AGENTS.md @@ -40,6 +40,14 @@ This ensures generated code always matches the version actually installed, not s - ❌ `Agent(llm=ChatOpenAI(...))` → ✅ `Agent(llm="openai/gpt-4o")` or `Agent(llm=LLM(model="..."))` - ❌ Passing raw OpenAI client objects → ✅ Use `crewai.LLM` wrapper +### Deprecated CLI scaffolding aliases (still supported) + +These commands remain supported but print a yellow deprecation warning. Prefer the canonical forms: + +- ⚠️ `crewai tool create ` → ✅ `crewai create tool ` +- ⚠️ `crewai skill create ` → ✅ `crewai create skill ` +- ⚠️ `crewai template add ` → ✅ `crewai create template ` + ### How to verify you're using current patterns: 1. You ran the version check and docs lookup steps above before writing code 2. All LLM references use `crewai.LLM` or string shorthand (`"openai/gpt-4o"`) @@ -137,8 +145,26 @@ uv sync # Sync dependencies uv lock # Lock dependencies # Project scaffolding -crewai create crew --skip_provider # New crew project -crewai create flow --skip_provider # New flow project +crewai create crew --skip_provider # New crew project +crewai create flow # New flow project +crewai create tool # Custom tool repository +crewai create skill # Agent skill (./skills/ in crew projects) +crewai create skill --no-project # Skill in current directory +crewai create template # Remote project template +crewai create template -o # Template with custom output directory + +# Deprecated scaffolding aliases (still work; print a yellow warning) +# crewai tool create → crewai create tool +# crewai skill create → crewai create skill +# crewai template add → crewai create template + +# Tool, skill, and template lifecycle (unchanged) +crewai tool install +crewai tool publish +crewai skill install @org/name +crewai skill publish +crewai skill list +crewai template list # Running crewai run # Run crew or flow (auto-detects from pyproject.toml) @@ -1133,7 +1159,9 @@ Python >=3.10, <3.14 ```bash uv tool install crewai # Install CrewAI CLI uv tool list # Verify installation -crewai create crew my_crew --skip_provider # Scaffold a new project +crewai create crew my_crew --skip_provider # Scaffold a crew project +crewai create tool my_tool # Scaffold a tool repository +crewai create skill my_skill # Scaffold an agent skill crewai install # Install project dependencies crewai run # Execute ```