Install app - GBOX docs

1

Get an API Key

Go to GBOX AI
Copy your API Key
Paste your GBOX API Key into your env file

.env

GBOX_API_KEY=gbox-******

2

Install GBOX SDK and other dependencies

Install gbox-sdk and other dependencies by running the following command in your terminal.

npm install gbox-sdk dotenv typescript tsx @types/node

# Set up a virtual environment
python3 -m venv venv
source venv/bin/activate

pip install gbox-sdk python-dotenv

3

Create Android box and install app

Create a basic Android box by running the following code.

import GboxSDK from "gbox-sdk";
import * as dotenv from "dotenv";

dotenv.config();

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"], // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "android" });

  console.log(`Android box created: ${box.data.id}`);

  // install markor (a open source markdown editor)
  const app = await box.app.install({
    apk: "https://github.com/gsantner/markor/releases/download/v2.14.1/net.gsantner.markor-v158-2.14.1-flavorDefault-release.apk"
  })

  // open the app
  await app.open()

  // you can also install an apk from your local machine
  // const app = await box.app.install({
  //   apk: "/path/to/your/app.apk"
  // })

  const liveView = await box.liveView()
  console.log(`Open the following URL in your browser to see the live view: ${liveView.url}`);
}

main();

import os
from dotenv import load_dotenv
from gbox_sdk import GboxSDK

# Load environment variables from .env file
load_dotenv()

def main():
    api_key = os.getenv("GBOX_API_KEY")

    gbox = GboxSDK(api_key=api_key)

    box = gbox.create(type="android")

    print(f"Android box created: {box.data.id}")

    # install markor (a open source markdown editor)
    app = box.app.install(
        apk="https://github.com/gsantner/markor/releases/download/v2.14.1/net.gsantner.markor-v158-2.14.1-flavorDefault-release.apk"
    )

    # open the app
    app.open()

    # you can also install an apk from your local machine
    # app = box.app.install({
    #     "apk": "/path/to/your/app.apk"
    # })

    live_view = box.live_view()
    print(f"Open the following URL in your browser to see the live view: {live_view.url}")

if __name__ == "__main__":
    main()

4

Run the box

Run the box by running the following command in your terminal.

npx tsx index.ts

python main.py

More Android Capabilities