npm - @magpiecloud/mags - Versions diffs - 1.5.1 → 1.6.1 - Mend

@magpiecloud/mags 1.5.1 → 1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/API.md +381 -0
package/Mags-API.postman_collection.json +374 -0
package/QUICKSTART.md +283 -0
package/README.md +287 -79
package/bin/mags.js +151 -27
package/deploy-page.sh +171 -0
package/index.js +1 -163
package/mags +0 -0
package/mags.sh +270 -0
package/nodejs/README.md +191 -0
package/nodejs/bin/mags.js +1146 -0
package/nodejs/index.js +326 -0
package/nodejs/package.json +42 -0
package/package.json +4 -15
package/python/INTEGRATION.md +747 -0
package/python/README.md +139 -0
package/python/dist/magpie_mags-1.0.0-py3-none-any.whl +0 -0
package/python/dist/magpie_mags-1.0.0.tar.gz +0 -0
package/python/examples/demo.py +181 -0
package/python/pyproject.toml +39 -0
package/python/src/magpie_mags.egg-info/PKG-INFO +164 -0
package/python/src/magpie_mags.egg-info/SOURCES.txt +9 -0
package/python/src/magpie_mags.egg-info/dependency_links.txt +1 -0
package/python/src/magpie_mags.egg-info/requires.txt +1 -0
package/python/src/magpie_mags.egg-info/top_level.txt +1 -0
package/python/src/mags/__init__.py +6 -0
package/python/src/mags/client.py +283 -0
package/skill.md +153 -0
package/website/api.html +927 -0
package/website/claude-skill.html +483 -0
package/website/cookbook/hn-marketing.html +410 -0
package/website/cookbook/hn-marketing.sh +50 -0
package/website/cookbook.html +278 -0
package/website/env.js +4 -0
package/website/index.html +718 -0
package/website/llms.txt +242 -0
package/website/login.html +88 -0
package/website/mags.md +171 -0
package/website/script.js +425 -0
package/website/styles.css +845 -0
package/website/tokens.html +171 -0
package/website/usage.html +187 -0

package/website/cookbook.html ADDED Viewed

@@ -0,0 +1,278 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>Mags Cookbook</title>
+    <meta
+      name="description"
+      content="Practical Mags recipes for running scripts, building workspaces, and exposing services."
+    />
+    <meta name="api-base" content="https://api.magpiecloud.com" />
+    <meta name="auth-base" content="https://api.magpiecloud.com" />
+    <link rel="stylesheet" href="styles.css?v=2" />
+    <script src="env.js"></script>
+  </head>
+  <body>
+    <div class="backdrop"></div>
+    <header class="site-header">
+      <div class="container nav">
+        <div class="brand">
+          <span class="logo">Mags</span>
+          <span class="tag">Cookbook</span>
+        </div>
+        <nav class="nav-links">
+          <a href="index.html">Home</a>
+          <a href="index.html#quickstart">Quickstart</a>
+          <a href="index.html#cli">CLI</a>
+          <a href="index.html#api">API</a>
+          <a href="login.html">Login</a>
+          <a href="usage.html">Usage</a>
+          <a href="tokens.html">Tokens</a>
+          <a href="claude-skill.html">Claude Skill</a>
+        </nav>
+        <div class="nav-cta">
+          <a class="button ghost" href="index.html#quickstart">Get started</a>
+        </div>
+      </div>
+    </header>
+    <main>
+      <section class="hero">
+        <div class="container hero-grid">
+          <div class="hero-copy">
+            <span class="pill">Recipes</span>
+            <h1>Hands-on workflows for developers and hobbyists.</h1>
+            <p class="lead">
+              Copy these recipes to bootstrap a new workspace, run tests, or expose a
+              service. Each example is built around real Mags commands.
+            </p>
+            <div class="hero-actions">
+              <a class="button" href="#recipes">Browse recipes</a>
+              <a class="button ghost" href="claude-skill.html">Claude integration</a>
+            </div>
+          </div>
+          <div class="hero-card">
+            <div class="card-header">
+              <span>Starter</span>
+              <span class="chip">Workflow</span>
+            </div>
+            <pre><code>mags new dev-env
+mags ssh dev-env
+# inside the VM
+apk add git nodejs npm</code></pre>
+            <p class="card-note">Create a persistent dev environment with one command.</p>
+          </div>
+        </div>
+      </section>
+      <section class="section" id="recipes">
+        <div class="container">
+          <div class="section-title">
+            <p>Cookbook</p>
+            <h2>Recipes you can reuse today.</h2>
+          </div>
+          <div class="recipe-list">
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Quick script run</h3>
+                <span class="pill">Starter</span>
+              </div>
+              <pre><code>mags run 'echo Hello World'</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Persistent Python workspace</h3>
+                <span class="pill">Workspace</span>
+              </div>
+              <pre><code>mags run -w ml-project \
+  'apk add python3 py3-pip && pip install numpy pandas'
+mags run -w ml-project \
+  'python3 train.py'</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Run tests with cached deps</h3>
+                <span class="pill">CI</span>
+              </div>
+              <pre><code>mags run -w myapp 'npm ci'
+mags run -w myapp 'npm test'</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Expose a simple web server</h3>
+                <span class="pill">URL</span>
+              </div>
+              <pre><code>mags run -p --url \
+  'python3 -m http.server 8080'</code></pre>
+              <p class="label">Remember: your app should listen on the same port.</p>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Node.js app with startup command</h3>
+                <span class="pill">Persistent</span>
+              </div>
+              <pre><code>mags run -w myapp -p --url --port 3000 \
+  --startup-command 'npm start' \
+  'npm install && npm start'</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Upload files and run</h3>
+                <span class="pill">File</span>
+              </div>
+              <pre><code># Upload a script and a data file, then run
+mags run -f analyze.py -f data.csv \
+  'python3 analyze.py'
+# Upload into a workspace (files persist)
+mags run -w analytics -f analyze.py -f data.csv \
+  'cp *.py *.csv /root/ && python3 /root/analyze.py'</code></pre>
+              <p class="label">Files land in <code>/root/</code> before your script runs.</p>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Ephemeral run (fastest)</h3>
+                <span class="pill">Speed</span>
+              </div>
+              <pre><code>mags run -e 'uname -a && df -h'</code></pre>
+              <p class="label">No workspace sync. Best for quick one-off commands.</p>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Manage cron jobs</h3>
+                <span class="pill">Cron</span>
+              </div>
+              <pre><code># Schedule a health check every 5 minutes
+mags cron add --name "health-check" \
+  --schedule "*/5 * * * *" -w monitors \
+  'curl -sf https://myapp.com/health || echo FAIL &gt;&gt; /root/alerts.log'
+# List all cron jobs
+mags cron list
+# Disable / enable / remove
+mags cron disable &lt;id&gt;
+mags cron enable &lt;id&gt;
+mags cron remove &lt;id&gt;</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>Inspect job output</h3>
+                <span class="pill">Debug</span>
+              </div>
+              <pre><code>mags list
+mags status &lt;job-id&gt;
+mags logs &lt;job-id&gt;</code></pre>
+            </article>
+            <article class="recipe-item" data-reveal>
+              <div class="recipe-header">
+                <h3>HN Marketing Digest</h3>
+                <span class="pill">Cron</span>
+              </div>
+              <pre><code># Upload script + install deps
+mags run -f cookbook/hn-marketing.sh -w hn-digest \
+  'cp hn-marketing.sh /root/ && chmod +x /root/hn-marketing.sh && apk add -q curl jq'
+# Activate cron (every 2 hours)
+mags cron add --name "hn-marketing" \
+  --schedule "0 */2 * * *" -w hn-digest \
+  'sh /root/hn-marketing.sh'</code></pre>
+              <p class="label"><a href="cookbook/hn-marketing.html">Full recipe + live demo →</a></p>
+            </article>
+          </div>
+        </div>
+      </section>
+      <section class="section">
+        <div class="container">
+          <div class="section-title">
+            <p>SDK + API</p>
+            <h2>Automate runs from code.</h2>
+          </div>
+          <div class="grid split">
+            <article class="panel" data-reveal>
+              <h3>Node.js SDK</h3>
+              <pre><code>const Mags = require('@magpiecloud/mags');
+const mags = new Mags({
+  apiToken: process.env.MAGS_API_TOKEN
+});
+// Run a script
+const result = await mags.runAndWait('echo Hello World');
+console.log(result.logs);
+// Upload files and run
+const fileIds = await mags.uploadFiles(['script.py', 'data.csv']);
+const res = await mags.run('python3 script.py', { fileIds });
+// Schedule a cron job
+await mags.cronCreate({
+  name: 'daily-backup',
+  cronExpression: '0 0 * * *',
+  script: 'tar czf backup.tar.gz /data',
+  workspaceId: 'my-workspace'
+});
+const { cron_jobs } = await mags.cronList();</code></pre>
+            </article>
+            <article class="panel" data-reveal>
+              <h3>REST API</h3>
+              <pre><code># Submit a job
+curl -X POST https://api.magpiecloud.com/api/v1/mags-jobs \
+  -H "Authorization: Bearer $MAGS_API_TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "script": "echo Hello World",
+    "type": "inline",
+    "workspace_id": "myproject",
+    "persistent": true
+  }'
+# Upload a file
+curl -X POST https://api.magpiecloud.com/api/v1/mags-files \
+  -H "Authorization: Bearer $MAGS_API_TOKEN" \
+  -F "file=@script.py"
+# Create a cron job
+curl -X POST https://api.magpiecloud.com/api/v1/mags-cron \
+  -H "Authorization: Bearer $MAGS_API_TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "name": "health-check",
+    "cron_expression": "*/5 * * * *",
+    "script": "curl -sf https://myapp.com/health"
+  }'</code></pre>
+            </article>
+          </div>
+        </div>
+      </section>
+    </main>
+    <footer class="site-footer">
+      <div class="container footer-grid">
+        <div>
+          <div class="brand">
+            <span class="logo">Mags</span>
+            <span class="tag">Instant sandboxes and runtime environments</span>
+          </div>
+          <p>Build, test, and run from clean microVMs whenever you need them.</p>
+        </div>
+        <div class="footer-links">
+          <a href="index.html">Home</a>
+          <a href="login.html">Login</a>
+          <a href="usage.html">Usage</a>
+          <a href="tokens.html">Tokens</a>
+          <a href="claude-skill.html">Claude Skill</a>
+          <a href="https://magpiecloud.com/docs/mags" rel="noreferrer">Documentation</a>
+        </div>
+      </div>
+    </footer>
+    <script src="script.js"></script>
+  </body>
+</html>

package/website/env.js ADDED Viewed

@@ -0,0 +1,4 @@
+window.MAGS_ENV = {
+  API_BASE: "http://localhost:9090",
+  AUTH_BASE: "http://localhost:9090"
+};