Quickstart
Get started with orbiads-cli in 3 steps.
Prerequisites
- Python 3.10+ — Check with python --version
- OrbiAds Account — Create an account on orbiads.com
- GAM Access — OAuth connection configured in the Dashboard
Step 1
Install the CLI
Install orbiads-cli via pip (Python 3.10+ required).
$ pip install orbiads-cli
Step 2
Sign in
Authenticate with your Google account via the OAuth Device Flow.
$ orbiads auth login
The browser opens automatically. Complete Google OAuth authorisation to continue.
Step 3
Run your first command
Verify the connection by fetching your GAM network information.
$ orbiads network info
Expected output
Network: My Publisher Network
Code: 66235823
Timezone: Europe/Paris
Currency: EUR
Code: 66235823
Timezone: Europe/Paris
Currency: EUR
Ready to explore?
Your CLI is installed and connected. Discover all available commands.
View the commands reference