Kaman VM Agent

A command-line tool to connect your virtual machine or local environment to the Kaman platform. This agent enables remote command execution and MCP (Model Context Protocol) server management through the Kaman platform.

Installation

You can run the Kaman VM Agent directly using npx without installing it globally:

npx @yoctotta/kaman-vm-agent --secret-key YOUR_SECRET_KEY

Or install it globally using yarn:

yarn global add @yoctotta/kaman-vm-agent
kaman-vm-agent --secret-key YOUR_SECRET_KEY
```A command-line tool to connect your virtual machine or local environment to the Kaman platform. This agent enables remote command execution and MCP (Model Context Protocol) server management through the Kaman platform.

## Installation

You can run the agent directly using npx without installing it globally:

```bash
npx kaman-vm-agent --secret-key YOUR_SECRET_KEY

Or install it globally:

yarn global add kaman-vm-agent
kaman-vm-agent --secret-key YOUR_SECRET_KEY

Usage

Basic Usage

npx @yoctotta/kaman-vm-agent --secret-key YOUR_SECRET_KEY

Advanced Usage

# Connect to a specific server
npx @yoctotta/kaman-vm-agent --server ws://kaman.example.com:3020 --secret-key YOUR_SECRET_KEY

# Specify user and agent IDs
npx @yoctotta/kaman-vm-agent --secret-key YOUR_SECRET_KEY --user-id user123 --agent-id my-agent

# Use environment variables
export SECRET_KEY=your_secret_key
export SERVER_URL=ws://kaman.example.com:3020
export USER_ID=user123
export AGENT_ID=my-agent
npx @yoctotta/kaman-vm-agent

Command Line Options

• -s, --server <url>: Server URL to connect to (default: ws://localhost:3020)
• -k, --secret-key <key>: Secret key for authentication (required)
• -u, --user-id <id>: User ID for the agent
• -a, --agent-id <id>: Agent ID (auto-generated if not provided)
• -h, --help: Display help information
• -V, --version: Display version number

Environment Variables

You can also use environment variables instead of command-line options:

• SERVER_URL: Server URL to connect to
• SECRET_KEY: Secret key for authentication (required)
• USER_ID: User ID for the agent
• AGENT_ID: Agent ID (auto-generated if not provided)

Features

• Real-time Communication: Connects to Kaman platform via WebSocket
• MCP Server Management: Register and manage Model Context Protocol servers
• Command Execution: Execute commands remotely through the Kaman platform
• Auto-reconnection: Automatically reconnects on connection loss
• Secure Authentication: Uses secret keys for secure communication

Getting Your Secret Key

To get your secret key:

1. Visit the Kaman platform dashboard
2. Navigate to VM Agents or Integration settings
3. Generate or copy your secret key
4. Use it with the --secret-key option or set it as the SECRET_KEY environment variable

Troubleshooting

Connection Issues

If you're having trouble connecting:

1. Verify your secret key is correct
2. Check that the server URL is accessible
3. Ensure your firewall allows WebSocket connections
4. Check the agent logs for specific error messages

Common Errors

• "Secret key is required": Make sure to provide the secret key via --secret-key option or SECRET_KEY environment variable
• "Connection refused": Check if the server URL is correct and the server is running
• "Authentication failed": Verify your secret key is valid and hasn't expired

Development

This package is part of the Kaman platform ecosystem. For development and contribution guidelines, please refer to the main Kaman repository.

Build Commands

# Development build (TypeScript compilation only)
yarn build:dev

# Standard build with basic obfuscation
yarn build

# Production build with maximum security obfuscation
yarn build:prod

# Verify security and obfuscation quality
yarn verify:security

Security Features

This package implements multiple layers of security to protect against reverse engineering:

Code Protection

• Heavy Obfuscation: Production builds use aggressive code obfuscation with multiple layers
• String Encryption: All strings are encrypted and stored in shuffled arrays
• Control Flow Flattening: Code execution paths are completely obscured
• Dead Code Injection: Dummy code is injected to confuse static analysis
• Variable Mangling: All identifiers are replaced with meaningless names
• Console Output Removal: All debugging output is stripped in production

CLI Compatibility

The obfuscation system uses different settings for CLI vs backend files:

• CLI Files: Moderate obfuscation to maintain command-line compatibility
• Backend Files: Maximum obfuscation with runtime protection features

Security Verification

# Analyze obfuscation quality and security measures
yarn verify:security

This tool provides detailed analysis of:

• Obfuscation effectiveness (0-100 score)
• Readable content detection
• Security feature presence
• Overall protection rating

License

PROPRIETARY - Copyright © 2025 Yoctotta Inc. All rights reserved.

This software is proprietary and confidential. Unauthorized reverse engineering, decompilation, or disassembly is prohibited.

Support

For support and questions:

• Visit Kaman Documentation
• Open an issue on the GitHub repository
• Contact support through the Kaman platform