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.

feat(cli): backfill project_id from every user-invoked project command (#7057)

João Moura0c2bcb510c8b
diff --git a/lib/cli/src/crewai_cli/cli.py b/lib/cli/src/crewai_cli/cli.py
index 11a9844bd..5b5ab984e 100644
--- a/lib/cli/src/crewai_cli/cli.py
+++ b/lib/cli/src/crewai_cli/cli.py
@@ -17,6 +17,7 @@ from crewai_cli.user_data import (
from crewai_cli.utils import (
build_env_with_all_tool_credentials,
enable_prompt_line_editing,
+ get_or_create_project_id,
is_dmn_mode_enabled,
read_toml,
warn_deprecated,
@@ -331,6 +332,11 @@ def train(
filename: str,
) -> None:
"""Train the crew."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
if deprecated_n_iterations is not None:
warn_deprecated(kind="flag", old="--n_iterations", new="--n-iterations")
n_iterations = deprecated_n_iterations
@@ -378,6 +384,11 @@ def replay(
task_id: The ID of the task to replay from.
trained_agents_file: Optional trained-agents pickle path.
"""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
if deprecated_task_id is not None:
warn_deprecated(kind="flag", old="--task_id", new="--task-id")
task_id = deprecated_task_id
@@ -593,6 +604,11 @@ def test(
trained_agents_file: str | None,
) -> None:
"""Test the crew and evaluate the results."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
if deprecated_n_iterations is not None:
warn_deprecated(kind="flag", old="--n_iterations", new="--n-iterations")
n_iterations = deprecated_n_iterations
@@ -669,6 +685,11 @@ def update() -> None:
@crewai.command()
def login() -> None:
"""Sign Up/Login to CrewAI AMP."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
Settings().clear_user_settings()
AuthenticationCommand().login()
@@ -703,6 +724,11 @@ def deploy() -> None:
)
def deploy_create(yes: bool, skip_validate: bool) -> None:
"""Create a Crew deployment."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
deploy_cmd = DeployCommand()
deploy_cmd.create_crew(yes, skip_validate=skip_validate)
@@ -723,6 +749,11 @@ def deploy_list() -> None:
)
def deploy_push(uuid: str | None, skip_validate: bool) -> None:
"""Deploy the Crew."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
deploy_cmd = DeployCommand()
deploy_cmd.deploy(uuid=uuid, skip_validate=skip_validate)
@@ -927,6 +958,11 @@ def flow_plot() -> None:
@click.argument("crew_name")
def flow_add_crew(crew_name: str) -> None:
"""Add a crew to an existing flow."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
from crewai_cli.add_crew_to_flow import add_crew_to_flow
click.echo(f"Adding crew {crew_name} to the flow")
@@ -1006,6 +1042,11 @@ def enterprise() -> None:
@click.argument("enterprise_url")
def enterprise_configure(enterprise_url: str) -> None:
"""Configure CrewAI AMP OAuth2 settings from the provided Enterprise URL."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
from crewai_cli.enterprise.main import EnterpriseConfigureCommand
enterprise_command = EnterpriseConfigureCommand()
@@ -1130,6 +1171,11 @@ def traces() -> None:
@traces.command("enable")
def traces_enable() -> None:
"""Enable trace collection for crew/flow executions."""
+ # Backfills a project_id for projects that have [tool.crewai] but no id yet.
+ # Safe in every command the user explicitly invoked: get_or_create_project_id
+ # is a no-op without a pyproject.toml and refuses to create [tool.crewai], so it
+ # never rewrites an unrelated directory. Never called from the SDK during kickoff.
+ get_or_create_project_id()
from rich.console import Console
from rich.panel import Panel
diff --git a/lib/crewai/tests/cli/test_project_id_backfill.py b/lib/crewai/tests/cli/test_project_id_backfill.py
new file mode 100644
index 000000000..19cdc6e66
--- /dev/null
+++ b/lib/crewai/tests/cli/test_project_id_backfill.py
@@ -0,0 +1,181 @@
+"""Every user-invoked CLI command that touches a project backfills its `project_id`.
+
+`crewai run` has always backfilled: a project that declares `[tool.crewai]` but no
+`project_id` gets one minted the first time the user runs it. No other command did,
+so a project driven entirely through `crewai test`, `crewai deploy` or
+`crewai traces enable` never acquired an id and every one of its runs stayed
+unattributable.
+
+These commands are all actions the user explicitly invoked, which is the same
+condition `run_crew` already relies on, so extending the backfill needs no new
+policy. It is still never called from the SDK during kickoff, and
+`get_or_create_project_id` still refuses to create the `[tool.crewai]` table, so an
+unrelated directory is never rewritten.
+
+The patched backfill RAISES here rather than returning. That proves the call happened
+and simultaneously guarantees nothing after it runs, so no test touches real user
+settings, spawns a subprocess, or reaches the network.
+"""
+
+from pathlib import Path
+from unittest import mock
+
+from click.testing import CliRunner
+from crewai_cli.cli import crewai
+import pytest
+
+
+class _BackfillReached(Exception):
+ """Raised by the patched backfill so the command stops at that point."""
+
+
+class _StopAfterBackfill(Exception):
+ """Raised at the first call AFTER the backfill, to stop without masking it.
+
+ Used where a call *count* is asserted. If the backfill itself raised, the count
+ would be capped at one by the mock rather than by the code under test, so a
+ duplicate call could never be observed.
+ """
+
+
+# (test id, argv). Args are the minimum click accepts; the command body is never
+# reached beyond the backfill call, so nothing here needs to be a valid target.
+COMMANDS = [
+ ("train", ["train", "-n", "1"]),
+ ("replay", ["replay", "-t", "task-1"]),
+ ("test", ["test"]),
+ ("login", ["login"]),
+ ("deploy_create", ["deploy", "create"]),
+ ("deploy_push", ["deploy", "push"]),
+ ("flow_add_crew", ["flow", "add-crew", "some_crew"]),
+ ("enterprise_configure", ["enterprise", "configure", "https://example.test"]),
+ ("traces_enable", ["traces", "enable"]),
+]
+
+
+def runner():
+ return CliRunner()
+
+
[email protected](("name", "argv"), COMMANDS, ids=[c[0] for c in COMMANDS])
+def test_command_backfills_project_id(runner, name, argv):
+ with mock.patch(
+ "crewai_cli.cli.get_or_create_project_id",
+ side_effect=_BackfillReached,
+ ) as backfill:
+ result = runner.invoke(crewai, argv)
+
+ assert backfill.called, (
+ f"`crewai {' '.join(argv)}` did not backfill project_id, so a project driven "
+ f"only through this command never becomes attributable"
+ )
+ assert isinstance(result.exception, _BackfillReached), (
+ "the backfill must be reached, not merely importable. This does NOT by itself "
+ "prove nothing ran before it -- see "
+ "test_backfill_precedes_command_specific_work for that, which pins the "
+ "ordering on one representative command"
+ )
+
+
+def test_backfill_precedes_command_specific_work(runner):
+ """The backfill runs before the command does anything of its own.
+
+ Placement is the point: a command that fails partway must still leave the project
+ with an id. The parametrized test above proves the backfill is *reached*, which is
+ not the same claim -- work could in principle happen first and still satisfy it.
+
+ Pinned on `login` because its first action is a call through a module-level name
+ (`Settings`) that can be patched without reaching into the command. One
+ representative command is deliberate: asserting this for all nine would mean
+ naming each command's current first action, which changes as commands evolve and
+ would make the suite track their internals rather than this ordering property.
+ """
+ with mock.patch(
+ "crewai_cli.cli.get_or_create_project_id", side_effect=_BackfillReached
+ ) as backfill, mock.patch("crewai_cli.cli.Settings") as settings:
+ result = runner.invoke(crewai, ["login"])
+
+ assert backfill.called
+ assert isinstance(result.exception, _BackfillReached)
+ assert not settings.called, (
+ "login touched its own first action before backfilling; a failure after that "
+ "point would leave the project without an id"
+ )
+
+
+MINIMAL_PYPROJECT = """\
+[project]
+name = "demo"
+version = "0.1.0"
+
+[tool.crewai]
+"""
+
+
+def _in_a_project(runner):
+ """A cwd that `crewai run` accepts, so execution reaches the backfill call."""
+ return runner.isolated_filesystem()
+
+
+def test_run_still_backfills(runner):
+ """`crewai run` was already correct and must stay that way.
+
+ The backfill returns normally and execution is stopped at the next call in
+ run_crew instead, so the recorded call count is real rather than an artifact of
+ the mock raising on first use.
+ """
+ with _in_a_project(runner):
+ Path("pyproject.toml").write_text(MINIMAL_PYPROJECT, encoding="utf-8")
+ with (
+ mock.patch("crewai_cli.run_crew.get_or_create_project_id") as backfill,
+ mock.patch(
+ "crewai_cli.run_crew.configured_project_json_crew",
+ side_effect=_StopAfterBackfill,
+ ),
+ ):
+ result = runner.invoke(crewai, ["run"])
+
+ assert backfill.call_count == 1, "`crewai run` stopped backfilling project_id"
+ assert isinstance(result.exception, _StopAfterBackfill), (
+ "execution must have reached the boundary after the backfill, otherwise the "
+ "call count above proves nothing about ordering"
+ )
+
+
+def test_flow_kickoff_delegates_the_backfill_and_does_not_duplicate_it(runner):
+ """`crewai flow kickoff` must inherit the backfill from run_crew, not repeat it.
+
+ A second call would mint under a lock run_crew is about to take -- wasted work
+ rather than a correctness bug, but it would also hide the delegation from anyone
+ reading the command.
+
+ Both backfill mocks return normally and execution is stopped at the first call
+ *after* the backfill in run_crew. That matters: if the backfill itself raised,
+ `call_count == 1` would be guaranteed by the mock rather than by the code, and a
+ duplicate call inside run_crew could never be observed at all.
+ """
+ with _in_a_project(runner):
+ Path("pyproject.toml").write_text(MINIMAL_PYPROJECT, encoding="utf-8")
+ with (
+ mock.patch("crewai_cli.cli.get_or_create_project_id") as in_cli,
+ mock.patch("crewai_cli.run_crew.get_or_create_project_id") as in_run_crew,
+ mock.patch(
+ "crewai_cli.run_crew.configured_project_json_crew",
+ side_effect=_StopAfterBackfill,
+ ),
+ ):
+ result = runner.invoke(crewai, ["flow", "kickoff"])
+
+ assert in_run_crew.call_count == 1, (
+ "flow kickoff must reach run_crew's backfill exactly once -- more than one "
+ "means it was duplicated somewhere on this path"
+ )
+ assert not in_cli.called, (
+ "flow kickoff must not add its own backfill call; it delegates to run_crew"
+ )
+ assert isinstance(result.exception, _StopAfterBackfill), (
+ "execution must have reached the boundary after run_crew's backfill. Without "
+ "this, both counts above would also pass if the path returned or raised "
+ "between the backfill and that boundary -- i.e. for the wrong reason"
+ )