Secure sandboxes that boot in milliseconds. Your data stays.

Install

pip install magpie-mags
export MAGS_API_TOKEN="your-token"

Methods

Run Options

Examples

from mags import Mags
m = Mags()  # reads MAGS_API_TOKEN from env

# Run a command and wait
result = m.run_and_wait("echo Hello World")
print(result["status"])    # "completed"

# Local workspace (no S3 sync, good for analysis)
m.run_and_wait("python3 analyze.py", workspace_id="analysis")

# Persistent workspace (synced to S3)
m.run("pip install flask",
    workspace_id="my-project", persistent=True)

# Create a sandbox (local disk)
m.new("my-project")

# Create with S3 persistence
m.new("my-project", persistent=True)

# Execute commands on existing sandbox
result = m.exec("my-project", "ls -la /root")
print(result["output"])

# Public URL
m.new("webapp", persistent=True)
info = m.url("webapp", port=3000)
print(info["url"])  # https://xyz.apps.magpiecloud.com

# Always-on sandbox (never auto-sleeps)
m.run("python3 worker.py",
    workspace_id="worker", persistent=True, no_sleep=True)

# Upload files
file_ids = m.upload_files(["script.py", "data.csv"])
m.run_and_wait("python3 /uploads/script.py", file_ids=file_ids)

# Workspaces
workspaces = m.list_workspaces()
m.delete_workspace("myproject")

# Cron
m.cron_create(name="backup", cron_expression="0 0 * * *",
    script="tar czf backup.tar.gz /data", workspace_id="backups")

Install

npm install @magpiecloud/mags
export MAGS_API_TOKEN="your-token"

Methods

Run Options

Examples

const Mags = require('@magpiecloud/mags');
const mags = new Mags({ apiToken: process.env.MAGS_API_TOKEN });

// Run a command and wait
const result = await mags.runAndWait('echo Hello World');
console.log(result.status);   // "completed"

// Local workspace (no S3 sync, good for analysis)
await mags.runAndWait('python3 analyze.py', { workspaceId: 'analysis' });

// Persistent workspace (synced to S3)
await mags.runAndWait('pip install flask', { workspaceId: 'myproject', persistent: true });
await mags.runAndWait('python3 app.py', { workspaceId: 'myproject', persistent: true });

// Base image
await mags.runAndWait('npm test', { baseWorkspaceId: 'golden' });
await mags.runAndWait('npm test', { baseWorkspaceId: 'golden', workspaceId: 'fork-1', persistent: true });

// Create a sandbox
await mags.new('dev', { persistent: true });

// SSH access
const job = await mags.run('sleep 3600', { workspaceId: 'dev', persistent: true });
const ssh = await mags.enableAccess(job.requestId, 22);
console.log(`ssh root@${ssh.sshHost} -p ${ssh.sshPort}`);

// Public URL
const webJob = await mags.run('python3 -m http.server 8080', {
  workspaceId: 'webapp', persistent: true,
  startupCommand: 'python3 -m http.server 8080',
});
const { url } = await mags.url('webapp', 8080);
console.log(url);

// Always-on sandbox (never auto-sleeps)
await mags.run('python3 worker.py', {
  workspaceId: 'worker', persistent: true, noSleep: true,
});

// Upload files
const fileId = await mags.uploadFile('script.py');
await mags.runAndWait('python3 /uploads/script.py', { fileIds: [fileId] });

// Cron
await mags.cronCreate({
  name: 'backup', cronExpression: '0 0 * * *',
  script: 'tar czf backup.tar.gz /data', workspaceId: 'backups',
});