README.md•3.48 kB
[foreverVM](https://forevervm.com)
==================================
[](https://github.com/jamsocket/forevervm)
[](https://discord.gg/N5sEpsuhh9)
| repo | version |
|-----------------------------------------------------|------------------------------|
| [cli](https://github.com/jamsocket/forevervm) | [](https://www.npmjs.com/package/forevervm) |
| [sdk](https://github.com/jamsocket/forevervm) | [](https://www.npmjs.com/package/@forevervm/sdk) |
foreverVM provides an API for running arbitrary, stateful Python code securely.
The core concepts in foreverVM are **machines** and **instructions**.
**Machines** represent a stateful Python process. You interact with a machine by running **instructions**
(Python statements and expressions) on it, and receiving the results. A machine processes one instruction
at a time.
Getting started
---------------
You will need an API token (if you need one, reach out to [paul@jamsocket.com](mailto:paul@jamsocket.com)).
The easiest way to try out foreverVM is using the CLI. First, you will need to log in:
```bash
npx forevervm login
```
Once logged in, you can open a REPL interface with a new machine:
```bash
npx forevervm repl
```
When foreverVM starts your machine, it gives it an ID that you can later use to reconnect to it. You can reconnect to a machine like this:
```bash
npx forevervm repl [machine_name]
```
You can list your machines (in reverse order of creation) like this:
```bash
npx forevervm machine list
```
You don't need to terminate machines -- foreverVM will automatically swap them from memory to disk when they are idle, and then
automatically swap them back when needed. This is what allows foreverVM to run repls “forever”.
Using the API
-------------
```typescript
import { ForeverVM } from '@forevervm/sdk'
const token = process.env.FOREVERVM_TOKEN
if (!token) {
throw new Error('FOREVERVM_TOKEN is not set')
}
// Initialize foreverVM
const fvm = new ForeverVM({ token })
// Connect to a new machine.
const repl = fvm.repl()
// Execute some code
let execResult = repl.exec('4 + 4')
// Get the result
console.log('result:', await execResult.result)
// We can also print stdout and stderr
execResult = repl.exec('for i in range(10):\n print(i)')
for await (const output of execResult.output) {
console.log(output.stream, output.data)
}
process.exit(0)
```
Working with Tags
----------------
You can create machines with tags and filter machines by tags:
```typescript
import { ForeverVM } from '@forevervm/sdk'
const fvm = new ForeverVM({ token: process.env.FOREVERVM_TOKEN })
// Create a machine with tags
const machineResponse = await fvm.createMachine({
tags: {
env: 'production',
owner: 'user123',
project: 'demo'
}
})
// List machines filtered by tags
const productionMachines = await fvm.listMachines({
tags: { env: 'production' }
})
```
Memory Limits
----------------
You can create machines with memory limits by specifying the memory size in megabytes:
```typescript
// Create a machine with 512MB memory limit
const machineResponse = await fvm.createMachine({
memory_mb: 512,
})
```