AugmentOS-Extended-Example-App

Install AugmentOS on your phone

AugmentOS install links: AugmentOS.org/install

(Easiest way to get started) Set up ngrok

1. brew install ngrok

2. Make an ngrok account

3. Use ngrok to make a static address/URL

Register your APP with AugmentOS

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's static URL or the public URL of your server

6. After the app is created, you will be given an API key. Copy this key and use it in the .env file below.

7. You can now add settings and tools to your app via the AugmentOS Developer Console. Let's upload this example's app_config.json file by clicking the "Import app_config.json" button under Configuration Management:

   

Get your APP running!

1. Install bun

2. Create a new repo from this template using the Use this template dropdown in the upper right or the following command: gh repo create --template AugmentOS-Community/AugmentOS-Extended-Example-App

   

3. Clone your new repo locally: git clone <your-repo-url>

4. cd into your repo, then type bun install

5. Set up your environment variables:

   • Create a .env file in the root directory by copying the example: cp .env.example .env
   • Edit the .env file with your app details:

     PORT=3000
     PACKAGE_NAME=com.yourName.yourAppName
     AUGMENTOS_API_KEY=your_api_key_from_console
     

   • Make sure the PACKAGE_NAME matches what you registered in the AugmentOS Console
   • Get your AUGMENTOS_API_KEY from the AugmentOS Developer Console

6. Run your app with bun run dev

7. To expose your app to the internet (and thus AugmentOS) with ngrok, run: ngrok http --url=<YOUR_NGROK_URL_HERE> 3000

   • 3000 is the port. It must match what is in the app config. For example, if you entered port: 8080, use 8080 for ngrok instead.

Next Steps

Check out the full documentation at docs.AugmentOS.org

Subscribing to events

You can listen for transcriptions, translations, settings updates, and other events within the onSession function.

Authenticated Webview

The app can provide an authenticated webview endpoint for users:

• Access the webview at /webview
• Authentication is handled automatically for AugmentOS users
• The current AugmentOS user is available at request.authUserId
• Create a web interface that allows users to interact with your app's functionality

Tool Calls

Your app can respond to tool calls via handleToolCall in your code:

• Define custom tools that can be called by AugmentOS
• Each tool takes specific parameters and returns a result
• Tools can perform operations on your application's data
• Properly handle authentication and validation in your tool implementations