Feat/cli #275

zzhangpurdue · 2025-12-09T02:35:20Z

Description

add cli system
pass test for run/web from project+entrypoint, project, entrypoint file
pass test for k8s/modelstudio/local deploy method by both cli and interface
pass test for k8s/local stop method, modelstudio has no stop logic yet, will be add soon
update temp file location and naming, all builds are sorted by platform-time, and store at user workspace/.agentscope_runtime, user could easily review/test and delete
add deploy state manager for deploy info management.
run by deploy id
lint
ut
docs

Todo:

pass test for agentrun deploy and stop by cli

Run an agent in interactive way with multi-turn

as-runtime run examples/deployments/detached_local_deploy/app_agent.py

Run an agent in simple reply

as-runtime run examples/deployments/detached_local_deploy/app_agent.py --query

Run an agent with webui

as-runtime web examples/deployments/detached_local_deploy/app_agent.py

Deployment

modelstudio

export USE_LOCAL_RUNTIME=True && as-runtime deploy modelstudio examples/deployments/detached_local_deploy/app_agent.py --name my-test6 --env DASHSCOPE_API_KEY=sk-xxx

k8s

# USE_LOCAL_RUNTIME will use local agentscope runtime instead of from pypi
export USE_LOCAL_RUNTIME=True && as-runtime deploy k8s examples/deployments/detached_local_deploy/app_agent.py --image-name agent_app --env DASHSCOPE_API_KEY=xxxx --image-tag linux-amd64-4 --registry-url yyy

local

as-runtime deploy local examples/deployments/detached_local_deploy/app_agent.py --env DASHSCOPE_API_KEY=sk-xxx

An URL will be print in the terminal, user could query the agent by this url,

curl -i -X POST "http:/127.0.0.1:8080/process" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 8ddcc903-b75b-40b8-ba7f-1501e05cb3f2" \
  -d '{
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": "Hello, how are you?"
          }
        ]
      }
    ],
    "session_id": "123"
  }'

or call run cli

as-runtime run  [DEPLOYMENT_ID]

A deployment id will be print in the terminal, then use it to stop

as-runtime stop [DEPLOYMENT_ID]

Related Issue: Fixes #[issue_number] or Relates to #[issue_number]

Security Considerations: [If applicable, especially for sandbox changes]

Type of Change

Component(s) Affected

Checklist

Pre-commit hooks pass
Tests pass locally
Documentation updated (if needed)
Ready for review

Testing

[How to test these changes]

Additional Notes

[Optional: any other context]

cla-assistant · 2025-12-09T02:35:34Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

Zhicheng Zhang seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

cla-assistant · 2025-12-09T02:35:35Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

Zhicheng Zhang seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Copilot

Pull request overview

This PR introduces a comprehensive CLI system for AgentScope Runtime, adding a unified as-runtime command-line interface that consolidates agent development, deployment, and runtime operations. The PR includes build caching for faster deployments, enhanced deployment management across multiple platforms (local, k8s, modelstudio, agentrun), and improved temporary file organization.

Key Changes:

New unified CLI system with commands: run, web, deploy, stop, list, status, invoke, sandbox
Build cache implementation with content-aware hashing for faster repeated deployments
Enhanced deployer interfaces with standardized stop() methods across all platforms

Reviewed changes

Copilot reviewed 46 out of 47 changed files in this pull request and generated 28 comments.

Show a summary per file

File	Description
`src/agentscope_runtime/cli/`	New CLI module with command implementations, agent loaders, state management, and utilities
`src/agentscope_runtime/engine/deployers/utils/build_cache.py`	Build cache system with content hashing and workspace management
`src/agentscope_runtime/engine/deployers/`	Updated deployers with stop() method, build directory improvements, and entrypoint support
`src/agentscope_runtime/engine/deployers/utils/docker_image_utils/`	Enhanced Docker image building with platform support and wheel merging
`src/agentscope_runtime/engine/deployers/utils/k8s_utils.py`	K8s environment detection for local vs cloud clusters
`tests/deploy/test_build_cache.py`	Comprehensive test suite for build cache functionality
`pyproject.toml`	Added click dependency and as-runtime console script
`examples/deployments/`	Example configuration files for various deployment platforms
`cookbook/en/cli/README.md`	CLI documentation and usage guide

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/agentscope_runtime/engine/deployers/utils/k8s_utils.py

src/agentscope_runtime/engine/deployers/utils/package.py

src/agentscope_runtime/cli/commands/stop.py

src/agentscope_runtime/cli/loaders/agent_loader.py

src/agentscope_runtime/engine/deployers/utils/build_cache.py

src/agentscope_runtime/engine/deployers/utils/k8s_utils.py

src/agentscope_runtime/cli/commands/web.py

# Conflicts: # cookbook/_toc.yml

rayrayraykk · 2025-12-10T11:58:03Z

pyproject.toml

 runtime-sandbox-mcp = "agentscope_runtime.sandbox.mcp_server:main"
 runtime-sandbox-server = "agentscope_runtime.sandbox.manager.server.app:main"
 runtime-sandbox-builder = "agentscope_runtime.sandbox.build:main"
 runtime-fc-deploy = "agentscope_runtime.engine.deployers.cli_fc_deploy:main"


Could we remove agentscope-runtime-fc-deploy and integrate to as-runtime / main cli?

rayrayraykk · 2025-12-10T12:00:44Z

pyproject.toml

 build-backend = "setuptools.build_meta"

 [project.scripts]
+as-runtime = "agentscope_runtime.cli.cli:main"


Instead of maintaining multiple long CLI entry points (runtime-sandbox-mcp, runtime-sandbox-server, runtime-fc-deploy, etc.), we could unify them into a single agentscope-runtime CLI and route to the specific functionalities via subcommands or arguments.
This would reduce duplication in pyproject.toml, make the commands easier to remember, and keep naming consistent.
For example:

agentscope-runtime sandbox mcp agentscope-runtime sandbox server agentscope-runtime sandbox build agentscope-runtime fc-deploy agentscope-runtime modelstudio mcp-server

rayrayraykk · 2025-12-10T12:04:47Z

src/agentscope_runtime/engine/runner.py

            from ..adapters.agentscope.message import message_to_agentscope_msg
+            from agentscope import setup_logger

+            setup_logger("ERROR")


Maybe move to adapters stream.py

rayrayraykk · 2025-12-10T12:18:45Z

src/agentscope_runtime/cli/commands/web.py

+
+@click.command()
+@click.argument("source", required=True)
+@click.option(


The default argument is mismatched with agent_app.run (0.0.0.0)

rayrayraykk · 2025-12-10T12:19:06Z

src/agentscope_runtime/cli/commands/web.py

+    help="Host address to bind to",
+    default="127.0.0.1",
+)
+@click.option(


The default argument is mismatched with agent_app.run (8080)

rayrayraykk · 2025-12-10T12:34:48Z

src/agentscope_runtime/cli/utils/console.py

@@ -0,0 +1,120 @@
+# -*- coding: utf-8 -*-


I’d strongly recommend leveraging Rich for output formatting instead of plain click.secho / ASCII tables:

Suggested improvements:

Centralize style config – avoid repeating emoji/color logic in each echo_* function. Define a STYLES dict and reuse.

Upgrade table rendering – replace manual ASCII table (format_table) with rich.table.Table for better alignment (handles wide chars) and richer visuals.

Improve JSON display – use rich.json.JSON or console.print_json() to give syntax‑highlighted JSON instead of plain json.dumps.

Consistent layout components – rich.panel.Panel or Columns can make headers and grouped output more readable.

Windows compatibility – Rich automatically handles ANSI colors on Windows, eliminating need for manual Click color handling.

These changes will make CLI output visually appealing, more readable, and more consistent across platforms, while keeping Click for argument parsing.

rayrayraykk · 2025-12-10T12:47:05Z

src/agentscope_runtime/cli/commands/run.py

@@ -0,0 +1,786 @@
+# -*- coding: utf-8 -*-


How about rename to chat?

rayrayraykk · 2025-12-10T12:52:17Z

src/agentscope_runtime/cli/commands/run.py

+    "'main.py')",
+    default=None,
+)
+def run(


Looks like interruption does not works in my IDE (pycharm)...

Maybe try signal.signal(signal.SIGINT, handle_sigint) ?

Zhicheng Zhang added 14 commits December 1, 2025 22:18

init commit

38e69cb

init commit

af4455f

update cli detail

5d6621b

working run & web

a515195

init lint

3743337

support entrypoint

5635da1

update deploy logic

7ab1b4f

running modelstudio deployment

7ca3d9b

running modelstudio deployment

b61b5c1

running modelstudio deployment with api and cli

b805a4d

running k8s interface

5046d40

running k8s interface and cli

8d76e45

running stop

d580e53

merge origin

e030748

Copilot AI review requested due to automatic review settings December 9, 2025 02:35

Copilot started reviewing on behalf of zzhangpurdue December 9, 2025 02:35 View session

Copilot AI reviewed Dec 9, 2025

View reviewed changes

zzhangpurdue changed the title ~~Feat/cli~~ [WIP]Feat/cli Dec 9, 2025

Zhicheng Zhang added 5 commits December 9, 2025 14:53

fix lint

470be59

update sandbox

7154b34

pass ut

ca221bd

fix stop management

03e0697

add state management ut

0ca1238

zzhangpurdue force-pushed the feat/cli branch from f449c4e to 0ca1238 Compare December 9, 2025 12:51

Zhicheng Zhang added 4 commits December 9, 2025 22:52

fix detached task with project input

f871c42

running local deployment

4ef6f4e

unify the deployment id

856ef52

remove useless part

6221009

Zhicheng Zhang added 6 commits December 10, 2025 11:35

add docs

4a75c66

fix ut and lint

873a404

Merge remote-tracking branch 'origin/main' into feat/cli

968b600

# Conflicts: # cookbook/_toc.yml

resolve coplit

89c25ed

support run for deployment id

067c362

run support streaming

d12b7e0

zzhangpurdue changed the title ~~[WIP]Feat/cli~~ Feat/cli Dec 10, 2025

rayrayraykk self-requested a review December 10, 2025 10:22

rayrayraykk reviewed Dec 10, 2025

View reviewed changes

Feat/cli #275

Are you sure you want to change the base?

Feat/cli #275

Uh oh!

Conversation

zzhangpurdue commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Component(s) Affected

Checklist

Testing

Additional Notes

Uh oh!

cla-assistant bot commented Dec 9, 2025

Uh oh!

cla-assistant bot commented Dec 9, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zzhangpurdue commented Dec 9, 2025 •

edited

Loading