promigence 0.1.0-beta.12

package/NOTICE

@@ -0,0 +1,14 @@
+Promigence — SDK and CLI (npm package `promigence`)
+Copyright 2026 Promigence AI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,88 @@
+# promigence
+
+The fastest sandboxes for AI agents and code. Snapshot an environment once, fork it as often as you need, run
+commands in every copy and get a report that tells environment failures apart from task failures.
+Billed per second, with a quote before a run and a hard spend cap. One package: the `promigence`
+command and the TypeScript SDK.
+
+Docs: https://www.promigence.ai/docs
+
+## Install
+
+You need Node.js 20 or newer.
+
+```sh
+npm i -g promigence
+promigence --version
+```
+
+On Linux, if `npm i -g` fails with a permissions error, run it with `sudo` or give npm a prefix you
+own (`npm config set prefix ~/.npm-global` and add `~/.npm-global/bin` to your `PATH`).
+
+## Create your account
+
+```sh
+promigence signup
+```
+
+It opens your browser to create the account. Your API key is saved in your system keychain, or in
+`~/.config/promigence/credentials` (mode 0600) where there is none.
+On another machine, use `promigence login`: it signs you in with a code we email you. In CI or on an
+agent's machine, set `PROMIGENCE_API_KEY` instead. `promigence doctor` checks the setup.
+
+## First commands
+
+```sh
+promigence me                                         # your credit and limits
+promigence pricing                                    # prices and limits, live
+
+# One command in 2 fresh sandboxes, then a report
+promigence run --count 2 --cap 1 -- python3 -c 'print(6*7)'
+
+# A sandbox you keep until its timeout
+promigence fork --count 1 --cap 1 --timeout 30m       # prints its id: sbx_...
+promigence exec --sandbox sbx_ID -- uname -a
+promigence sandbox shell sbx_ID                       # a live terminal
+promigence files put ./app.py /tmp/app.py --sandbox sbx_ID
+promigence sandbox kill sbx_ID
+
+# Your own environment: build it once, fork it as often as you like
+promigence snapshot create --image python:3.12-slim --alias py --wait
+promigence fork --snapshot py --count 5 --cap 2
+```
+
+`promigence --help` lists every command; `promigence <command> --help` explains one.
+
+## For AI agents
+
+Run `promigence agent-guide` (about 1.4k tokens) before driving the CLI: it covers the model, the
+JSON output contract, exit codes and errors. `promigence agent-guide --install` writes the same
+guidance into your repo for coding agents, and `promigence mcp` serves the CLI as an MCP server.
+Every command takes `--json`.
+
+## From TypeScript
+
+In your project (the global install gives you the command only):
+
+```sh
+npm i promigence
+```
+
+```ts
+import { Sandbox } from "promigence";
+
+const sbx = await Sandbox.create();
+const r = await sbx.commands.run("echo hello");
+console.log(r.stdout);
+await sbx.kill();
+```
+
+The SDK is also published on its own as `@promigence/sdk`.
+
+## Support
+
+support@promigence.ai
+
+## Licence
+
+Apache-2.0. See `NOTICE`.