ags.md

ags

AGS CLI - Command-line tool for Tencent Cloud Agent Sandbox

Synopsis

ags [command] [flags]
ags [flags]              # Enter REPL mode

Description

AGS CLI provides a convenient way to manage sandbox tools, instances, and execute code in isolated environments. It supports both E2B API and Tencent Cloud API backends.

When invoked without arguments, AGS enters interactive REPL mode with auto-completion support.

Commands

Command	Aliases	Description
tool	t	Tool (sandbox template) management
instance	i	Sandbox instance management
run	r	Execute code in sandbox
exec	x	Execute shell commands in sandbox
file	f, fs	File operations in sandbox
proxy	-	Forward a sandbox port to localhost
mobile	m	Mobile sandbox ADB access
apikey	ak, key	API key management (cloud backend only)
completion	-	Generate shell completion scripts
help	-	Help about any command

Global Options

Flag	Type	Default	Description
--backend	string	e2b	API backend: e2b or cloud
--config	string	~/.ags/config.toml	Config file path
-o, --output	string	text	Output format: text or json
--region	string	ap-guangzhou	Region for API access
--domain	string	tencentags.com	Base domain
--internal	bool	false	Use internal endpoints (for Tencent Cloud internal network)
--e2b-api-key	string	-	E2B API key
--cloud-secret-id	string	-	Tencent Cloud SecretID
--cloud-secret-key	string	-	Tencent Cloud SecretKey

Deprecated Flags

Flag	Replacement
--e2b-domain	--domain
--e2b-region	--region
--cloud-region	--region
--cloud-internal	--internal

Configuration

Create ~/.ags/config.toml:

backend = "e2b"
output = "text"
region = "ap-guangzhou"          # Unified region for all backends
domain = "tencentags.com"        # Unified base domain (optional)
internal = false                 # When true, "internal." is prepended to domain automatically

[e2b]
api_key = "your-e2b-api-key"

[cloud]
secret_id = "your-secret-id"
secret_key = "your-secret-key"

For full configuration reference including environment variables, internal network setup, priority rules, and deprecated field migration, see ags-config.

Examples

# Enter REPL mode
ags

# List tools
ags tool list

# Execute Python code
ags run -c "print('Hello')"

# Execute shell command
ags exec "ls -la"

# Use cloud backend
ags --backend cloud tool list

See Also

• ags-config - Configuration reference
• ags-tool - Tool management
• ags-instance - Instance management
• ags-run - Code execution
• ags-exec - Shell command execution
• ags-file - File operations
• ags-proxy - Port forwarding
• ags-mobile - Mobile sandbox ADB access
• ags-apikey - API key management