Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.osmedeus.org/llms.txt

Use this file to discover all available pages before exploring further.

The notification and CDN setup can be modify directly in the settings file. This page is to provide you a quick reference for the most common configurations through CLI and hot to verify your setup.

Notification Configuration

## Telegram Setup
osmedeus config set notification.enabled true
osmedeus config set notification.telegram.enabled true
osmedeus config set notification.provider telegram
osmedeus config set notification.telegram.bot_token "12345:your-token"
osmedeus config set notification.telegram.chat_id "-1001234567890"
verify your setup by sending a sample message with utility function osmedeus eval 'notify_telegram("**hola** osmedeus from cli")'
Notification Functions
Use osmedeus func ls noti to list all available notification functions.

How to get your telegram token and channel ID

Here are a quick guide on how to get your telegram token and channel ID
Search for @BotFather and create your bot then grab the token

# get channel ID
curl "https://api.telegram.org/bot$TELEGRAM_TOKEN/getUpdates" | jq 

# send a test message
curl -X POST "https://api.telegram.org/bot$TELEGRAM_TOKEN/sendMessage" -d chat_id=-<channel-id> -d text="Hello, this is a broadcast to the channel"

CDN Configuration

Use osmedeus func ls cdn to list all available CDN functions. Below are some of the functions I usually use:
CDN Functions

osmedeus eval 'cdn_ls_tree()'

# download and upload result
osmedeus eval cdn_download("workspace_result.jsonl", "workspace_result.jsonl")
osmedeus eval cdn_upload("workspace_result.jsonl", "workspace_result.jsonl")

# sync folder to remote
osmedeus eval 'cdn_sync_upload("local", "remote")'

osmedeus eval 'cdn_ls_tree("targets/")'

Cloudflare R2

## CDN Setup for R2
osmedeus config set storage.provider 'r2'
osmedeus config set storage.access_key_id '<r2-key-id>'
osmedeus config set storage.bucket '<r2-bucket-name>'
osmedeus config set storage.secret_access_key '<r2-access-key>'
osmedeus config set storage.endpoint '<endpoint>.r2.cloudflarestorage.com'
osmedeus config set storage.presign_expiry '2h'
osmedeus config set storage.use_ssl 'true'
osmedeus config set storage.enabled 'true'
verify your setup by sending a sample message with utility function osmedeus eval 'cdn_ls_tree()'

Google Cloud Storage

## CDN Setup for GCS
osmedeus config set storage.provider 'gcs'
osmedeus config set storage.access_key_id '<gcs-key-id>'
osmedeus config set storage.secret_access_key '<gcs-access-key>'
osmedeus config set storage.bucket '<gcs-bucket-name>'
osmedeus config set storage.endpoint 'storage.googleapis.com'
osmedeus config set storage.region 'us-east-1'
osmedeus config set storage.use_ssl 'true'
osmedeus config set storage.presign_expiry '1h'
osmedeus config set storage.enabled 'true'
verify your setup by sending a sample message with utility function osmedeus eval 'cdn_ls_tree()'

Full Notification and CDN Configuration