wuying-agentbay-sdk 0.3.0 → 0.3.6

package/README.md

@@ -44,99 +44,142 @@ npm install wuying-agentbay-sdk
 
 ## Examples
 
-The SDK includes several examples demonstrating various features:
+You can find examples in the `docs/examples/typescript` directory, including:
 
-- **basic-usage.ts**: Basic SDK usage
-- **session-creation/**: Session creation and management
-- **session-params/**: Using session parameters and labels
-- **context-management/**: Context creation and management
-- **application-window/**: Application and window management
-- **command-example/**: Command execution and code running
-- **filesystem-example/**: File system operations
-- **ui-example/**: UI interactions
-- **label-management/**: Session label management
+- Basic SDK usage
+- Context management
+- Command execution
+- File system operations
+- UI interaction
+- Application management
+- Window management
+- Session management
 
-## Running Examples
-
-You can run the example file using ts-node:
+To run the examples:
 
 ```bash
-npx ts-node examples/basic-usage.ts
+npx ts-node docs/examples/typescript/basic-usage.ts
 ```
 
 ## TypeScript-Specific Usage
 
 ```typescript
-import { AgentBay } from 'wuying-agentbay-sdk';
+import { AgentBay, ListSessionParams } from 'wuying-agentbay-sdk';
 
 async function main() {
   // Initialize with API key
   const agentBay = new AgentBay({ apiKey: 'your_api_key' });
+
+  // Create a session with optional parameters
+  const createResponse = await agentBay.create({
+    imageId: 'linux_latest',  // Optional: specify the image to use
+    contextId: 'your_context_id',  // Optional: bind to an existing context
+    labels: {
+      purpose: 'demo',
+      environment: 'development'
+    }
+  });
+  const session = createResponse.session;
+  
+  // Execute a command
+  const commandResponse = await session.command.executeCommand('ls -la');
+  
+  // Run code
+  const codeResponse = await session.code.runCode('print("Hello World")', 'python');
+  
+  // File operations
+  const fileContent = await session.fileSystem.readFile('/etc/hosts');
+  await session.fileSystem.writeFile('/tmp/test.txt', 'Hello World');
+  
+  // UI operations
+  const screenshot = await session.ui.screenshot();
+  
+  // Application management
+  const installedApps = await session.application.getInstalledApps(true, false, true);
+  const visibleApps = await session.application.listVisibleApps();
+  
+  // Window management
+  const windows = await session.window.listRootWindows();
+  const activeWindow = await session.window.getActiveWindow();
   
-  try {
-    // Create a session with labels
-    const session = await agentBay.create({
-      labels: {
-        purpose: 'demo',
-        environment: 'development'
-      }
-    });
-    log(`Session created with ID: ${session.sessionId}`);
-    
-    // Execute a command
-    const result = await session.command.executeCommand('ls -la');
-    log(`Command result: ${result}`);
-    
-    // Read a file
-    const content = await session.filesystem.readFile('/path/to/file.txt');
-    log(`File content: ${content}`);
-    
-    // Run code
-    const pythonCode = `
-import os
-import platform
-
-print(f"Current working directory: {os.getcwd()}")
-print(f"Python version: {platform.python_version()}")
-`;
-    const codeResult = await session.command.runCode(pythonCode, 'python');
-    log(`Code execution result: ${codeResult}`);
-    
-    // Get installed applications
-    const apps = await session.application.getInstalledApps(true, false, true);
-    log(`Found ${apps.length} installed applications`);
-    
-    // List visible applications
-    const processes = await session.application.listVisibleApps();
-    log(`Found ${processes.length} visible applications`);
-    
-    // List root windows
-    const windows = await session.window.listRootWindows();
-    log(`Found ${windows.length} root windows`);
-    
-    // Get active window
-    const activeWindow = await session.window.getActiveWindow();
-    log(`Active window: ${activeWindow.title}`);
-    
-    // Get session labels
-    const labels = await session.getLabels();
-    log(`Session labels: ${JSON.stringify(labels)}`);
-    
-    // List sessions by labels
-    const filteredSessions = await agentBay.listByLabels({
-      purpose: 'demo'
-    });
-    log(`Found ${filteredSessions.length} matching sessions`);
-    
-    // Clean up
-    await agentBay.delete(session);
-    log('Session deleted successfully');
-  } catch (error) {
-    logError('Error:', error);
-  }
+  // Session management
+  await session.setLabels({ environment: 'production' });
+  const labels = await session.getLabels();
+  const info = await session.info();
+  
+  // Context management
+  const contexts = await agentBay.context.list();
+  
+  // Clean up
+  await agentBay.delete(session);
 }
-
-main();
 ```
 
-For more detailed documentation, please refer to the main [README](../README.md) and [SDK Documentation](../docs/README.md) in the project root.
+## Key Features
+
+### Session Management
+
+- Create sessions with optional parameters (imageId, contextId, labels)
+- List sessions with pagination and filtering by labels
+- Delete sessions and clean up resources
+- Manage session labels
+- Get session information and links
+
+### Command Execution
+
+- Execute shell commands
+- Run code in various languages
+- Get command output and execution status
+
+### File System Operations
+
+- Read and write files
+- List directory contents
+- Create and delete files and directories
+- Get file information
+
+### UI Interaction
+
+- Take screenshots
+- Find UI elements by criteria
+- Click on UI elements
+- Send text input
+- Perform swipe gestures
+- Send key events
+
+### Application Management
+
+- Get installed applications
+- List running applications
+- Start and stop applications
+- Get application information
+
+### Window Management
+
+- List windows
+- Get active window
+- Focus, resize, and move windows
+- Get window properties
+
+### Context Management
+
+- Create, list, and delete contexts
+- Bind sessions to contexts
+- Synchronize context data
+- Get context information
+
+### OSS Integration
+
+- Upload files to OSS
+- Download files from OSS
+- Initialize OSS environment
+
+## Response Format
+
+All API methods return responses that include:
+
+- `requestId`: A unique identifier for the request
+- `success`: A boolean indicating whether the operation was successful
+- Operation-specific data (varies by method)
+
+For more detailed documentation, refer to the [SDK Documentation](../docs/README.md).