Skip to content

Commit 319a20c

Browse files
authored
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.
1 parent 8320178 commit 319a20c

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

lib/cli/src/crewai_cli/templates/AGENTS.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ This ensures generated code always matches the version actually installed, not s
4040
-`Agent(llm=ChatOpenAI(...))` → ✅ `Agent(llm="openai/gpt-4o")` or `Agent(llm=LLM(model="..."))`
4141
- ❌ Passing raw OpenAI client objects → ✅ Use `crewai.LLM` wrapper
4242

43+
### Deprecated CLI scaffolding aliases (still supported)
44+
45+
These commands remain supported but print a yellow deprecation warning. Prefer the canonical forms:
46+
47+
- ⚠️ `crewai tool create <handle>` → ✅ `crewai create tool <handle>`
48+
- ⚠️ `crewai skill create <name>` → ✅ `crewai create skill <name>`
49+
- ⚠️ `crewai template add <name>` → ✅ `crewai create template <name>`
50+
4351
### How to verify you're using current patterns:
4452
1. You ran the version check and docs lookup steps above before writing code
4553
2. All LLM references use `crewai.LLM` or string shorthand (`"openai/gpt-4o"`)
@@ -137,8 +145,26 @@ uv sync # Sync dependencies
137145
uv lock # Lock dependencies
138146

139147
# Project scaffolding
140-
crewai create crew <name> --skip_provider # New crew project
141-
crewai create flow <name> --skip_provider # New flow project
148+
crewai create crew <name> --skip_provider # New crew project
149+
crewai create flow <name> # New flow project
150+
crewai create tool <handle> # Custom tool repository
151+
crewai create skill <name> # Agent skill (./skills/ in crew projects)
152+
crewai create skill <name> --no-project # Skill in current directory
153+
crewai create template <name> # Remote project template
154+
crewai create template <name> -o <output_dir> # Template with custom output directory
155+
156+
# Deprecated scaffolding aliases (still work; print a yellow warning)
157+
# crewai tool create <handle> → crewai create tool <handle>
158+
# crewai skill create <name> → crewai create skill <name>
159+
# crewai template add <name> → crewai create template <name>
160+
161+
# Tool, skill, and template lifecycle (unchanged)
162+
crewai tool install <handle>
163+
crewai tool publish
164+
crewai skill install @org/name
165+
crewai skill publish
166+
crewai skill list
167+
crewai template list
142168

143169
# Running
144170
crewai run # Run crew or flow (auto-detects from pyproject.toml)
@@ -1133,7 +1159,9 @@ Python >=3.10, <3.14
11331159
```bash
11341160
uv tool install crewai # Install CrewAI CLI
11351161
uv tool list # Verify installation
1136-
crewai create crew my_crew --skip_provider # Scaffold a new project
1162+
crewai create crew my_crew --skip_provider # Scaffold a crew project
1163+
crewai create tool my_tool # Scaffold a tool repository
1164+
crewai create skill my_skill # Scaffold an agent skill
11371165
crewai install # Install project dependencies
11381166
crewai run # Execute
11391167
```

0 commit comments

Comments
 (0)