Skip to main content

✅ Quickstart

Last updated: March 31, 2025

This is the recommended way to build an AugmentOS smart glasses app as of March 31 2025. The SDK is currently in beta.

AugmentOS is how you write powerful smart glasses apps. In this Quickstart, let's go from 0 to fully functioning app (that works on these smart glasses) in less than 15 minutes.

Prerequisites​

  • Node.js (v18 or later)
  • Bun
  • Basic TypeScript knowledge

Building Your First App​

The quickest way to get started is using our example app. This guide assumes you have a pair of compatible smart glasses connected to a phone running the AugmentOS app.

Install AugmentOS on your phone​

Download AugmentOS from AugmentOS.org/install

Set up ngrok​

  1. Install ngrok
  2. Create an ngrok account
  3. Set up a static address/URL in the ngrok dashboard
  • Make sure you run the ngrok config add-authtoken <your_authtoken> line.
  • Make sure you select Static Domain, then generate a static domain.

Register your app with AugmentOS​

AugmentOS Console

  1. Navigate to console.AugmentOS.org
  2. Click "Sign In" and log in with the same account you're using for AugmentOS
  3. Click "Create App"
  4. Set a unique package name like com.yourName.yourAppName
  5. For "Public URL", enter your ngrok static URL

Get your app running​

  1. Install bun
  2. Clone the example repo: 
    git clone git@github.com:AugmentOS-Community/AugmentOS-Cloud-Example-App.git
  3. Navigate to the repo directory and install dependencies: 
    cd AugmentOS-Cloud-Example-App
    bun install
  4. Edit your index.ts to match the app you registered: 
    const app = new ExampleAugmentOSApp({
      packageName: 'com.yourName.yourAppName', // The packageName you specified on console.AugmentOS.org
      apiKey: 'your_api_key', // Get this from console.AugmentOS.org
      port: 3000 // The port you're hosting the server on
    });
  5. Run your app: 
    bun run index.ts
  6. Expose your app to the internet with ngrok: 
    ngrok http --url=<YOUR_NGROK_URL_HERE> 3000
    Note: 3000 is the port. It must match what is in the app config. If you changed it to 8080, use 8080 for ngrok instead.

For more information, visit the AugmentOS-Cloud-Example-App repository.

Next Steps​