Using the SDK

Quick Start

1. Set the FOREVERVM_TOKEN environment variable:

   FOREVERVM_TOKEN=***

   Tip

   If you’d prefer to explicitly pass the API token rather than relying on environment variables, you can do that too! Full documentation is available in the REPL Reference.

2. Connect to a machine and run some code:

   Python

   from forevervm_sdk import Repl
   
   with Repl() as repl:
       instruction = repl.exec('4 + 4')
       print(instruction["result"])

   JavaScript

   import { Repl } from "@forevervm/sdk";
   
   const repl = new Repl();
   
   const instruction = repl.exec("4 + 4");
   console.log(await instruction.result);

Example

Below, you can see a short example of how to use the ForeverVM SDK.

Python

import os
from forevervm_sdk import ForeverVM

token = os.getenv('FOREVERVM_TOKEN')

# Initialize ForeverVM
fvm = ForeverVM(token)

# Connect to a new machine
with fvm.repl() as repl:

    # Execute some code
    exec_result = repl.exec('4 + 4')

    # Get the result
    print('result:', exec_result.result)

    # Execute code with output
    exec_result = repl.exec('for i in range(10):\n  print(i)')

    for output in exec_result.output:
        print(output["stream"], output["data"])

JavaScript

import { ForeverVM } from "@forevervm/sdk";

const token = process.env.FOREVERVM_TOKEN;

// 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);

Reference

Continue to the next section to see a reference of the SDK classes and methods.