A Python SDK and CLI tool for creating, managing, and interacting with Morph Cloud VMs.
Project description
MorphCloud Python SDK
Overview
MorphCloud is a platform designed to spin up remote AI devboxes we call runtimes. It provides a suite of code intelligence tools and a Python SDK to manage, create, delete, and interact with runtime instances.
Setup Guide
Prerequisites
Python 3.11 or higher
Go to https://cloud.morph.so, log in with the provided credentials and create an API key.
Set the API key as an environment variable MORPH_API_KEY.
Installation
pip install morphcloud
Export the API key:
export MORPH_API_KEY="your-api-key"
Python API
The SDK provides a Python API to interact with the MorphCloud API.
The following example creates a minimal vm snapshot, starts and instance then sets up a simple HTTP server and makes an HTTP request to it.
import time
import requests
import tempfile
from morphcloud.api import MorphCloudClient
# Connect to the MorphCloud API
# The API key can be set through the client or as an environment variable MORPH_API_KEY
client = MorphCloudClient()
# Create a snapshot with 1 vCPU, 128MB memory, 700MB disk size, and the image "morphvm-minimal"
snapshot = client.snapshots.create(vcpus=1, memory=128, disk_size=700, image_id="morphvm-minimal")
# Start an instance from the snapshot and open an SSH connection
with client.instances.start(snapshot_id=snapshot.id) as instance, instance.ssh() as ssh:
# Install uv and python using the ssh connection
ssh.run(["curl -LsSf https://astral.sh/uv/install.sh | sh"]).raise_on_error()
ssh.run(["echo 'source $HOME/.local/bin/env' >> $HOME/.bashrc"]).raise_on_error()
ssh.run(["uv", "python", "install"]).raise_on_error()
# Create an index.html file locally and copy it to the instance
with tempfile.NamedTemporaryFile(mode="w") as f:
f.writelines("<h1>Hello, World!</h1>")
f.flush()
ssh.copy_to(f.name, "index.html")
# Start an HTTP server on the instance with a tunnel to the local machine and run it in the background
with ssh.run(["uv", "run", "python3", "-m", "http.server", "8080", "--bind", "127.0.0.1"], background=True) as http_server, \
ssh.tunnel(local_port=8888, remote_port=8080) as tunnel:
# Wait for the HTTP server to start
time.sleep(1)
print("HTTP Server:", http_server.stdout)
print("Making HTTP request")
response = requests.get("http://127.0.0.1:8888", timeout=10)
print("HTTP Response:", response.status_code)
print(response.text)
Command Line Interface
The SDK also provides a command line interface to interact with the MorphCloud API. You can use the CLI to create, delete, and manage runtime instances.
Images
List available images:
morph image list [--json]
Snapshots
# List all snapshots
morph snapshot list [--json]
# Create a new snapshot
morph snapshot create --image-id <id> --vcpus <n> --memory <mb> --disk-size <mb> [--digest <hash>]
# Delete a snapshot
morph snapshot delete <snapshot-id>
Instances
# List all instances
morph instance list [--json]
# Start a new instance from snapshot
morph instance start <snapshot-id> [--json]
# Stop an instance
morph instance stop <instance-id>
# Get instance details
morph instance get <instance-id>
# Create snapshot from instance
morph instance snapshot <instance-id> [--json]
# Clone an instance
morph instance branch <instance-id> [--count <n>]
Instance Management
# Execute command on instance
morph instance exec <instance-id> <command>
# SSH into instance
morph instance ssh <instance-id> [command]
# Port forwarding
morph instance port-forward <instance-id> <remote-port> [local-port]
# Expose HTTP service
morph instance expose-http <instance-id> <name> <port>
# Hide HTTP service
morph instance hide-http <instance-id> <name>
Container Deployment
Deploy and run OCI containers:
morph instance crun [options] [command]
Options:
--image TEXT Container image (default: python:3.11-slim)
--expose-http TEXT HTTP service to expose (format: name:port)
--vcpus INTEGER Number of VCPUs (default: 1)
--memory INTEGER Memory in MB (default: 128)
--disk-size INTEGER Disk size in MB (default: 700)
--force-rebuild Force rebuild the container
--instance-id TEXT Use existing instance instead of creating new
--verbose Enable verbose logging (default: True)
--json Output in JSON format
Interactive Chat
Start an interactive chat session with an instance:
Note: You'll need to set ANTHROPIC_API_KEY environment variable to use this command.
morph instance chat <instance-id> [instructions]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file morphcloud-0.1.17.tar.gz.
File metadata
- Download URL: morphcloud-0.1.17.tar.gz
- Upload date:
- Size: 71.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16ed6982d00df7ec442abae1ce4d5c06b00d07ad6af9f0f24208e078e95c91a0
|
|
| MD5 |
60cafcca8e878b16f271f14376dceeb8
|
|
| BLAKE2b-256 |
f8a377f5a4b7735d3686f2673349938b5f2f7b8d3cb9191e8bd3fd9d7ac5dfe5
|
File details
Details for the file morphcloud-0.1.17-py3-none-any.whl.
File metadata
- Download URL: morphcloud-0.1.17-py3-none-any.whl
- Upload date:
- Size: 38.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3baa68878d699378326423b2b8d76eb629320a235b5016dff7d1ecfb946f67e1
|
|
| MD5 |
bfe3707d4bf1d022d8fec62bb03ee7eb
|
|
| BLAKE2b-256 |
e85a04d704b9fa4952a9394286b733d114223f8e47b631db59698f96655a1284
|