Skip to content

docs: improve docstring and comments in CLI module #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hobostay wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve docstring and comments in CLI module #374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions trae_agent/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,14 +212,15 @@ def run(
docker_keep: bool = True,
):
"""
Run is the main function of trae. it runs a task using Trae Agent.
Run is the main function of trae. It runs a task using Trae Agent.

Args:
tasks: the task that you want your agent to solve. This is required to be in the input
model: the model expected to be use
working_dir: the working directory of the agent. This should be set either in cli or in the config file
task: The task description you want your agent to solve
model: The model to use for execution
working_dir: The working directory for the agent. Set via CLI or config file

Return:
None (it is expected to be ended after calling the run function)
Returns:
None
"""

docker_config: dict[str, str | None] | None = None
Expand Down Expand Up @@ -257,7 +258,7 @@ def run(
elif docker_image:
docker_config = {"image": docker_image}
console.print(f"[blue]Docker mode enabled. Using image: {docker_image}[/blue]")
# --- ADDED END ---
# Docker mode configuration complete

# Apply backward compatibility for config file
config_file = resolve_config_file(config_file)
Expand Down