Skip to main content

Basic Usage

from gravixlayer import GravixLayer

client = GravixLayer()
runtime = client.runtime.create(template="python-3.12-base-small")

result = client.runtime.run_cmd(
    runtime.runtime_id,
    command="ls",
    args=["-la", "/workspace"],
)
print(result.stdout)
print(result.exit_code)

client.runtime.kill(runtime.runtime_id)

Install Packages

from gravixlayer import GravixLayer

client = GravixLayer()
runtime = client.runtime.create(template="python-3.12-base-small")

# Install a Python package
client.runtime.run_cmd(runtime.runtime_id, command="pip", args=["install", "pandas"])

# Verify installation
result = client.runtime.run_cmd(runtime.runtime_id, command="python", args=["-c", "import pandas; print(pandas.__version__)"])
print(result.stdout)

client.runtime.kill(runtime.runtime_id)

Run Shell Scripts

from gravixlayer import GravixLayer

client = GravixLayer()
runtime = client.runtime.create(template="python-3.12-base-small")

result = client.runtime.run_cmd(
    runtime.runtime_id,
    command="sh",
    args=["-lc", "echo $HOME && python --version"],
)
print(result.stdout)

client.runtime.kill(runtime.runtime_id)

With Environment Variables

from gravixlayer import GravixLayer

client = GravixLayer()
runtime = client.runtime.create(template="python-3.12-base-small")

result = client.runtime.run_cmd(
    runtime.runtime_id,
    command="sh",
    args=["-lc", "echo APP_MODE=$APP_MODE"],
    environment={"APP_MODE": "production"},
)
print(result.stdout)  # APP_MODE=production

client.runtime.kill(runtime.runtime_id)

Parameters

ParameterTypeRequiredDescription
runtime_idstringYesRuntime identifier
commandstringYesCommand to execute
argslist[string]NoCommand arguments
working_dirstringNoWorking directory
environmentobjectNoEnvironment variables
timeoutintegerNoTimeout in seconds

Response

FieldTypeDescription
stdoutstringStandard output
stderrstringStandard error
exit_codeintegerProcess exit code
duration_msintegerExecution duration in milliseconds
successbooleanTrue when exit code is 0
errorstringAPI-level error (if any)