docs: update scaffold AGENTS.md for unified create CLI - #6829
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughChangesThe CLI template documentation now lists canonical scaffolding commands, deprecated aliases, lifecycle commands, and installation examples for crews, flows, tools, skills, and templates. CLI scaffolding documentation
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/cli/src/crewai_cli/templates/AGENTS.md`:
- Line 144: Remove the no-op --skip_provider option from the “crewai create flow
<name>” example, leaving the flow command consistent with the create_flow
invocation that only uses name and declarative.
- Around line 42-44: Update the command alias descriptions in AGENTS.md to label
`crewai tool create`, `crewai skill create`, and `crewai template add` as
deprecated rather than removed or outdated. State that each alias remains
supported and emits a deprecation warning, while preserving the recommended
command forms.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 128d984f-b069-4ace-9147-d6575d356659
📒 Files selected for processing (1)
lib/cli/src/crewai_cli/templates/AGENTS.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/cli/src/crewai_cli/templates/AGENTS.md`:
- Around line 658-660: Update the `@listen("...")` documentation to state that
string targets may refer to a method name or an event/route label, while
clarifying that the target must not share the decorated handler’s method name.
Preserve the explanation that router return values, route labels, and method
completion events use the same trigger namespace.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 89cf6b93-bb17-400d-8979-80d4f04b5fc0
📒 Files selected for processing (1)
lib/cli/src/crewai_cli/templates/AGENTS.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/cli/src/crewai_cli/templates/AGENTS.md`:
- Around line 674-678: Resolve the merge conflict in the paragraph describing
handler names and conversational flows: remove the `<<<<<<< HEAD`, `=======`,
and `>>>>>>> main` markers and retain one complete paragraph, including the
guidance not to name a handler after the route it serves.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: dd8f97f9-1905-4870-a8f6-a78819140781
📒 Files selected for processing (1)
lib/cli/src/crewai_cli/templates/AGENTS.md
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.
968e655 to
e6ffbe7
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
|
/code-rabbit review |
2 participants
Summary
Updates the project template
AGENTS.md(copied into new projects bycrewai create) to document the unified scaffolding CLI from #6821.crewai create tool,create skill, andcreate templatecommandstool create,skill create,template add) that still work with warningsTest plan
lib/cli/src/crewai_cli/templates/AGENTS.mdcrewai create crew test_projand confirm copiedAGENTS.mdincludes the new commands