wuying-agentbay-sdk 0.7.0 → 0.9.0

package/README.md

@@ -24,18 +24,23 @@ async function main() {
     // Create session
     const agentBay = new AgentBay();
     const result = await agentBay.create();
-    
+    // Verified: ✓ Client initialized and session created successfully
+
     if (result.success) {
         const session = result.session;
-        
+
         // Execute command
         const cmdResult = await session.command.executeCommand("ls -la");
         console.log(cmdResult.output);
-        
+        // Verified: ✓ Command executed successfully
+        // Sample output: "总计 100\ndrwxr-x--- 16 wuying wuying 4096..."
+
         // File operations
         await session.fileSystem.writeFile("/tmp/test.txt", "Hello World");
         const content = await session.fileSystem.readFile("/tmp/test.txt");
-        console.log(content.data);
+        console.log(content.content);
+        // Verified: ✓ File written and read successfully
+        // Output: "Hello World"
     }
 }
 
@@ -45,18 +50,22 @@ main().catch(console.error);
 ## 📖 Complete Documentation
 
 ### 🆕 New Users
-- [📚 Quick Start Tutorial](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart) - Get started in 5 minutes
+- [📚 Quick Start Tutorial](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/README.md) - Get started in 5 minutes
 - [🎯 Core Concepts](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/basic-concepts.md) - Understanding cloud environments and sessions
-- [💡 Best Practices](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/best-practices.md) - Common patterns and techniques
 
 ### 🚀 Experienced Users
-- [📖 Feature Guides](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides) - Complete feature introduction
-- [🔧 TypeScript API Reference](docs/api/) - Detailed API documentation
-- [💻 TypeScript Examples](docs/examples/) - Complete example code
+**Choose Your Cloud Environment:**
+- 🌐 [Browser Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/browser-use/README.md) - Web scraping, browser testing, form automation
+- 🖥️ [Computer Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/computer-use/README.md) - Windows desktop automation, UI testing
+- 📱 [Mobile Use](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/mobile-use/README.md) - Android UI testing, mobile app automation
+- 💻 [CodeSpace](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/codespace/README.md) - Code execution, development environments
+
+**Additional Resources:**
+- [📖 Feature Guides](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/guides/README.md) - Complete feature introduction
+- [🔧 TypeScript API Reference](docs/api/README.md) - Detailed API documentation
+- [💻 TypeScript Examples](docs/examples/README.md) - Complete example code
 
 ### 🆘 Need Help
-- [❓ FAQ](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/faq.md) - Quick answers
-- [🔧 Troubleshooting](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/quickstart/troubleshooting.md) - Problem diagnosis
 - [🔧 TypeScript API Reference](docs/api/README.md) - Local API documentation
 - [💡 TypeScript Examples](docs/examples/README.md) - Local example code
 
@@ -66,12 +75,7 @@ main().catch(console.error);
 ```typescript
 // Create session
 const session = (await agentBay.create()).session;
-
-// List sessions
-const sessions = await agentBay.list();
-
-// Connect to existing session
-const session = await agentBay.connect("session_id");
+// Verified: ✓ Session created successfully
 ```
 
 ### File Operations
@@ -79,9 +83,12 @@ const session = await agentBay.connect("session_id");
 // Read and write files
 await session.fileSystem.writeFile("/path/file.txt", "content");
 const content = await session.fileSystem.readFile("/path/file.txt");
+// Verified: ✓ File operations work correctly
+// content.content contains the file's text content
 
 // List directory
 const files = await session.fileSystem.listDirectory("/path");
+// Verified: ✓ Returns list of file/directory information
 ```
 
 ### Command Execution
@@ -89,27 +96,32 @@ const files = await session.fileSystem.listDirectory("/path");
 // Execute command
 const result = await session.command.executeCommand("node script.js");
 console.log(result.output);
+// Verified: ✓ Command executed successfully
+// result.output contains the command's stdout
 ```
 
 ### Data Persistence
 ```typescript
 // Create context
 const context = (await agentBay.context.get("my-project", true)).context;
+// Verified: ✓ Context created or retrieved successfully
 
 // Create session with context
 import { ContextSync, SyncPolicy } from 'wuying-agentbay-sdk';
 const contextSync = new ContextSync({
     contextId: context.id,
-    path: "/mnt/data",
+    path: "/tmp/data",
     policy: SyncPolicy.default()
 });
 const session = (await agentBay.create({ contextSync: [contextSync] })).session;
+// Verified: ✓ Session created with context synchronization
+// Data in /tmp/data will be synchronized to the context
 ```
 
 ## 🆘 Get Help
 
 - [GitHub Issues](https://github.com/aliyun/wuying-agentbay-sdk/issues)
-- [Complete Documentation](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs)
+- [Complete Documentation](https://github.com/aliyun/wuying-agentbay-sdk/tree/main/docs/README.md)
 
 ## 📄 License