@magpiecloud/mags 1.8.9 → 1.8.11

package/README.md

@@ -15,18 +15,10 @@ Mags is a CLI and SDK for running scripts on ephemeral microVMs. Each execution
 
 ## Installation
 
-### npm (recommended)
-
 ```bash
 npm install -g @magpiecloud/mags
 ```
 
-### Go CLI
-
-```bash
-go install github.com/magpiecloud/mags/cmd/mags@latest
-```
-
 ## Authentication
 
 ### Interactive Login (Recommended)
@@ -261,15 +253,80 @@ const Mags = require('@magpiecloud/mags');
 const mags = new Mags({
   apiToken: process.env.MAGS_API_TOKEN
 });
+```
+
+### SDK Methods
 
+#### Jobs
+
+| Method | Description |
+|--------|-------------|
+| `run(script, options)` | Submit a job. Options: `name`, `workspaceId`, `baseWorkspaceId`, `persistent`, `noSleep`, `ephemeral`, `startupCommand`, `environment`, `fileIds`, `diskGb` |
+| `runAndWait(script, options)` | Submit and block until done. Extra options: `timeout`, `pollInterval` |
+| `new(name, options)` | Create a persistent VM and wait until running. Options: `baseWorkspaceId`, `diskGb`, `timeout` |
+| `status(requestId)` | Get job status |
+| `logs(requestId)` | Get job logs |
+| `list({page, pageSize})` | List recent jobs (paginated) |
+| `findJob(nameOrId)` | Find job by name, workspace ID, or request ID |
+| `updateJob(requestId, {startupCommand, noSleep})` | Update job settings |
+| `stop(nameOrId)` | Stop a job (accepts name, workspace ID, or request ID) |
+| `exec(nameOrId, command, {timeout})` | Execute a command on a running/sleeping VM via SSH |
+| `sync(requestId)` | Sync workspace to S3 without stopping |
+| `resize(workspace, diskGb)` | Resize workspace disk (stops VM, creates new one) |
+| `usage({windowDays})` | Get aggregated usage summary |
+
+#### URL & Access
+
+| Method | Description |
+|--------|-------------|
+| `enableAccess(requestId, port)` | Enable SSH (port 22) or HTTP access (default 8080) |
+| `url(nameOrId, port)` | Enable public URL and return the full URL |
+| `urlAliasCreate(subdomain, workspaceId, domain)` | Create a stable URL alias for a workspace |
+| `urlAliasList()` | List all URL aliases |
+| `urlAliasDelete(subdomain)` | Delete a URL alias |
+
+#### Workspaces
+
+| Method | Description |
+|--------|-------------|
+| `listWorkspaces()` | List all workspaces |
+| `deleteWorkspace(workspaceId)` | Delete a workspace and its S3 data |
+
+#### Files
+
+| Method | Description |
+|--------|-------------|
+| `uploadFiles(filePaths)` | Upload local files, returns array of file IDs |
+
+#### Cron Jobs
+
+| Method | Description |
+|--------|-------------|
+| `cronCreate({name, cronExpression, script, workspaceId, environment, persistent})` | Create a scheduled job |
+| `cronList()` | List all cron jobs |
+| `cronGet(id)` | Get a cron job |
+| `cronUpdate(id, updates)` | Update a cron job |
+| `cronDelete(id)` | Delete a cron job |
+
+### SDK Examples
+
+```javascript
 // Run and wait for completion
 const result = await mags.runAndWait('echo Hello World');
 console.log(result.logs);
 
-// Run with workspace
-const { requestId } = await mags.run('python script.py', {
+// Create a persistent VM
+await mags.new('myproject');
+
+// Execute command on existing VM
+const { output } = await mags.exec('myproject', 'ls -la /root');
+console.log(output);
+
+// Run with workspace and options
+const job = await mags.run('python script.py', {
   workspaceId: 'myproject',
   persistent: true,
+  diskGb: 5,
   startupCommand: 'python server.py'
 });
 
@@ -280,22 +337,18 @@ await mags.run('node server.js', {
   noSleep: true
 });
 
-// Get status
-const status = await mags.status(requestId);
-console.log(status);
-
-// Get logs
-const logs = await mags.logs(requestId);
-logs.logs.forEach(l => console.log(l.message));
+// Enable public URL
+const { url } = await mags.url('my-api', 3000);
+console.log(url); // https://abc123.apps.magpiecloud.com
 
-// Enable URL access
-await mags.enableUrl(requestId, 8080);
+// Create stable URL alias
+await mags.urlAliasCreate('my-app', 'my-api');
 
-// List jobs
-const jobs = await mags.list({ page: 1, pageSize: 10 });
+// Resize workspace disk
+await mags.resize('myproject', 10); // 10GB
 
-// Stop a job
-await mags.stop(requestId);
+// Stop a job by name
+await mags.stop('myproject');
 ```
 
 ## API Endpoints
@@ -414,9 +467,9 @@ SSH connects through our proxy. If you have issues:
 
 ## Support
 
-- Documentation: https://magpiecloud.com/docs/mags
-- Issues: https://github.com/magpiecloud/mags/issues
-- Dashboard: https://magpiecloud.com/mags
+- Documentation: https://mags.run
+- API Reference: https://mags.run/api.html
+- Dashboard: https://mags.run/tokens.html
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magpiecloud/mags",
-  "version": "1.8.9",
+  "version": "1.8.11",
   "description": "Mags CLI - Execute scripts on Magpie's instant VM infrastructure",
   "main": "index.js",
   "bin": {
@@ -20,11 +20,7 @@
   ],
   "author": "Magpie Cloud",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/magpiecloud/mags"
-  },
-  "homepage": "https://magpiecloud.com/docs/mags",
+  "homepage": "https://mags.run",
   "engines": {
     "node": ">=14.0.0"
   }