Skip to content

Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

fix(cli): flow add-crew finds the package from pyproject (#8082)

João Moura18473adc33ae
diff --git a/lib/cli/src/crewai_cli/add_crew_to_flow.py b/lib/cli/src/crewai_cli/add_crew_to_flow.py
index 9942d7ce2..44a772c13 100644
--- a/lib/cli/src/crewai_cli/add_crew_to_flow.py
+++ b/lib/cli/src/crewai_cli/add_crew_to_flow.py
@@ -2,8 +2,9 @@ from pathlib import Path
import click
from crewai_core.printer import PRINTER
+from crewai_core.project import read_toml
-from crewai_cli.utils import copy_template
+from crewai_cli.utils import copy_template, normalize_package_name
def add_crew_to_flow(crew_name: str) -> None:
@@ -16,12 +17,7 @@ def add_crew_to_flow(crew_name: str) -> None:
"This command must be run from the root of a flow project."
)
- flow_folder = Path.cwd()
- crews_folder = flow_folder / "src" / flow_folder.name / "crews"
-
- if not crews_folder.exists():
- PRINTER.print("Crews folder does not exist in the current flow.", color="red")
- raise click.ClickException("Crews folder does not exist in the current flow.")
+ crews_folder = _find_crews_folder(Path.cwd())
create_embedded_crew(crew_name, parent_folder=crews_folder)
@@ -30,6 +26,37 @@ def add_crew_to_flow(crew_name: str) -> None:
)
+def _find_crews_folder(flow_folder: Path) -> Path:
+ """Locate the flow package's crews folder from ``[project].name``.
+
+ The package directory follows ``[project].name``, not the folder the project
+ was cloned into. Only a project without a name falls back to a single
+ ``src/*/crews``, so a crew is never written into a package the name contradicts.
+ """
+ project = read_toml(flow_folder / "pyproject.toml").get("project", {})
+ package_name = normalize_package_name(project.get("name", ""))
+ if package_name:
+ expected = Path("src") / package_name / "crews"
+ if (flow_folder / expected).is_dir():
+ return flow_folder / expected
+ message = (
+ f"Crews folder does not exist in the current flow (expected {expected})."
+ )
+ else:
+ found = sorted(
+ path for path in flow_folder.glob("src/*/crews") if path.is_dir()
+ )
+ if len(found) == 1:
+ return found[0]
+ names = ", ".join(str(path.relative_to(flow_folder)) for path in found)
+ message = (
+ f"pyproject.toml has no [project].name and found {len(found)} crews "
+ f"folders under src/ ({names or 'none'}); expected exactly one."
+ )
+ PRINTER.print(message, color="red")
+ raise click.ClickException(message)
+
+
def create_embedded_crew(crew_name: str, parent_folder: Path) -> None:
"""Create a new crew within an existing flow project."""
folder_name = crew_name.replace(" ", "_").replace("-", "_").lower()
diff --git a/lib/cli/tests/test_cli.py b/lib/cli/tests/test_cli.py
index de2103716..4a5738370 100644
--- a/lib/cli/tests/test_cli.py
+++ b/lib/cli/tests/test_cli.py
@@ -453,37 +453,145 @@ def test_deploy_remove_no_uuid(command, runner):
mock_deploy.remove_crew.assert_called_once_with(uuid=None)
[email protected]("crewai_cli.add_crew_to_flow.create_embedded_crew")
[email protected]("pathlib.Path.exists", return_value=True)
-def test_flow_add_crew(mock_path_exists, mock_create_embedded_crew, runner):
- crew_name = "new_crew"
- result = runner.invoke(flow_add_crew, [crew_name])
+def _flow_project(
+ root: Path, project_name: str | None, package_dirs: list[str]
+) -> Path:
+ """Lay out a flow project at ``root`` with ``src/<dir>/crews`` per package dir."""
+ root.mkdir(parents=True)
+ name_line = f'name = "{project_name}"\n' if project_name else ""
+ (root / "pyproject.toml").write_text(f'[project]\n{name_line}version = "0.1.0"\n')
+ for package_dir in package_dirs:
+ (root / "src" / package_dir / "crews").mkdir(parents=True)
+ return root
+
+
+ ("folder", "project_name", "package_dir"),
+ [
+ ("lead_qualifier", "lead_qualifier", "lead_qualifier"),
+ ("use-case-lead-qualifier", "lead_qualifier", "lead_qualifier"),
+ ("use-case-lead-qualifier", "lead-qualifier", "lead_qualifier"),
+ ("checkout", "Lead Qualifier", "lead_qualifier"),
+ ],
+)
+def test_flow_add_crew_finds_package_from_project_name(
+ tmp_path, monkeypatch, runner, folder, project_name, package_dir
+):
+ root = _flow_project(tmp_path / folder, project_name, [package_dir])
+ monkeypatch.chdir(root)
+
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code == 0, result.output
+ assert "Adding crew new_crew to the flow" in result.output
+ crew_dir = root / "src" / package_dir / "crews" / "new_crew"
+ assert (crew_dir / "new_crew.py").is_file()
+ assert (crew_dir / "config" / "agents.yaml").is_file()
+ assert (crew_dir / "config" / "tasks.yaml").is_file()
+
+
+def test_flow_add_crew_prefers_project_name_over_other_crews_folders(
+ tmp_path, monkeypatch, runner
+):
+ root = _flow_project(tmp_path / "proj", "alpha", ["alpha", "beta"])
+ monkeypatch.chdir(root)
+
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code == 0, result.output
+ assert (root / "src" / "alpha" / "crews" / "new_crew" / "new_crew.py").is_file()
+ assert not (root / "src" / "beta" / "crews" / "new_crew").exists()
+
+
+def test_flow_add_crew_without_project_name_uses_single_crews_folder(
+ tmp_path, monkeypatch, runner
+):
+ root = _flow_project(tmp_path / "proj", None, ["qualifier"])
+ monkeypatch.chdir(root)
+
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code == 0, result.output
+ assert (root / "src" / "qualifier" / "crews" / "new_crew" / "new_crew.py").is_file()
- assert result.exit_code == 0, f"Command failed with output: {result.output}"
- assert f"Adding crew {crew_name} to the flow" in result.output
- mock_create_embedded_crew.assert_called_once()
- call_args, call_kwargs = mock_create_embedded_crew.call_args
- assert call_args[0] == crew_name
- assert "parent_folder" in call_kwargs
- assert isinstance(call_kwargs["parent_folder"], Path)
+def test_flow_add_crew_rejects_crews_folder_that_contradicts_project_name(
+ tmp_path, monkeypatch, runner
+):
+ root = _flow_project(tmp_path / "proj", "lead-qualifier", ["other_pkg"])
+ monkeypatch.chdir(root)
+ result = runner.invoke(flow_add_crew, ["new_crew"])
-def test_add_crew_to_flow_not_in_root(runner):
- with mock.patch("pathlib.Path.exists", autospec=True) as mock_exists:
- def exists_side_effect(self):
- if self.name == "pyproject.toml":
- return False
- return True
+ assert result.exit_code != 0
+ expected = Path("src", "lead_qualifier", "crews")
+ assert (
+ f"Crews folder does not exist in the current flow (expected {expected})."
+ in result.output
+ )
+ assert list((root / "src" / "other_pkg" / "crews").iterdir()) == []
+ assert not (root / "src" / "lead_qualifier").exists()
+
+
+def test_flow_add_crew_without_project_name_rejects_several_crews_folders(
+ tmp_path, monkeypatch, runner
+):
+ root = _flow_project(tmp_path / "proj", None, ["beta", "alpha"])
+ monkeypatch.chdir(root)
+
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code != 0
+ alpha = Path("src", "alpha", "crews")
+ beta = Path("src", "beta", "crews")
+ assert (
+ f"pyproject.toml has no [project].name and found 2 crews folders under "
+ f"src/ ({alpha}, {beta}); expected exactly one."
+ ) in result.output
+ assert list((root / "src" / "alpha" / "crews").iterdir()) == []
+ assert list((root / "src" / "beta" / "crews").iterdir()) == []
+
+
+ ("project_name", "expected_message"),
+ [
+ (
+ "alpha",
+ "Crews folder does not exist in the current flow "
+ f"(expected {Path('src', 'alpha', 'crews')}).",
+ ),
+ (
+ None,
+ "pyproject.toml has no [project].name and found 0 crews folders "
+ "under src/ (none); expected exactly one.",
+ ),
+ ],
+)
+def test_flow_add_crew_without_crews_folder_errors(
+ tmp_path, monkeypatch, runner, project_name, expected_message
+):
+ root = _flow_project(tmp_path / "proj", project_name, [])
+ (root / "src" / "alpha").mkdir(parents=True)
+ monkeypatch.chdir(root)
+
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code != 0
+ assert expected_message in result.output
+ assert list((root / "src" / "alpha").iterdir()) == []
- mock_exists.side_effect = exists_side_effect
- result = runner.invoke(flow_add_crew, ["new_crew"])
+def test_add_crew_to_flow_not_in_root(tmp_path, monkeypatch, runner):
+ (tmp_path / "src" / "proj" / "crews").mkdir(parents=True)
+ monkeypatch.chdir(tmp_path)
- assert result.exit_code != 0
- assert "This command must be run from the root of a flow project." in str(
- result.output
- )
+ result = runner.invoke(flow_add_crew, ["new_crew"])
+
+ assert result.exit_code != 0
+ assert "This command must be run from the root of a flow project." in str(
+ result.output
+ )
+ assert not (tmp_path / "src" / "proj" / "crews" / "new_crew").exists()
@mock.patch("crewai_cli.task_outputs.load_task_outputs")