Execute Commands

from cmdop import AsyncCMDOPClient
 
async with AsyncCMDOPClient.remote(api_key="cmd_xxx") as client:
    # Connect to the target remote machine by hostname
    await client.terminal.set_machine("my-server")
 
    # Execute a single command and capture its output and exit code
    output, exit_code = await client.terminal.execute("ls -la")
 
    print(output)       # Command output (stdout + stderr combined)
    print(exit_code)    # 0 = success, non-zero = failure

# Run a long-running build with a 10-minute timeout limit
output, code = await client.terminal.execute(
    "./build.sh",
    timeout=600  # Timeout in seconds (600s = 10 minutes)
)
 
# Run a quick command with a short 5-second timeout
output, code = await client.terminal.execute(
    "echo hello",
    timeout=5
)

# Execute a command in a specific directory using the cwd parameter
output, code = await client.terminal.execute(
    "npm install",
    cwd="/app/frontend"  # Sets the working directory before execution
)
 
# Alternative: chain cd with the command using shell operators
output, code = await client.terminal.execute(
    "cd /app && npm install"
)

# Pass custom environment variables to the command via the env dict
output, code = await client.terminal.execute(
    "./deploy.sh",
    env={
        "NODE_ENV": "production",  # Set Node.js environment mode
        "API_KEY": "secret"        # Pass secrets as env vars (not CLI args)
    }
)

from cmdop.exceptions import TimeoutError, SessionNotFoundError
 
try:
    output, code = await client.terminal.execute("command")
 
    # Check the exit code to determine if the command succeeded
    if code != 0:
        print(f"Command failed with code {code}")
        print(f"Error output: {output}")
 
except TimeoutError:
    # Raised when the command exceeds the specified timeout duration
    print("Command timed out")
 
except SessionNotFoundError:
    # Raised when the target machine is not connected or unreachable
    print("Machine not connected")

# Good: use absolute paths to avoid PATH resolution issues
output, code = await client.terminal.execute("/usr/bin/python3 script.py")
 
# Avoid: relies on PATH which may differ on the remote machine
output, code = await client.terminal.execute("python3 script.py")

# Good: properly quoted argument containing spaces
output, code = await client.terminal.execute('grep "hello world" file.txt')
 
# Avoid: unquoted arguments are split by the shell incorrectly
output, code = await client.terminal.execute("grep hello world file.txt")

output, code = await client.terminal.execute("./script.sh")
 
# Always verify the exit code - non-zero means the command failed
if code != 0:
    raise Exception(f"Script failed: {output}")

# Chain commands with && so each runs only if the previous succeeded
output, code = await client.terminal.execute(
    "cd /app && npm install && npm run build"
)

# Define a list of independent commands to execute one by one
commands = ["uptime", "df -h", "free -m"]
 
# Loop through and execute each command separately
for cmd in commands:
    output, code = await client.terminal.execute(cmd)
    print(f"{cmd}: {output}")

# Override the default shell by specifying the shell parameter
output, code = await client.terminal.execute(
    "echo $SHELL",
    shell="/bin/zsh"  # Use zsh instead of the default /bin/sh
)