4.3 KiB
4.3 KiB
OSMAP CLI - Embed Map Navigator & Token Manager
A lightweight CLI tool for developers and administrators to manage authentication tokens and quickly navigate or launch OSMAP KAI embed map routes across different environments (live, beta, staging, demo, local).
⚡ Quick Start (No Installation Needed)
1. Prerequisites
- Bash (
Git Bash,WSL,Linux, ormacOS) curljq(JSON processor)- Windows (PowerShell as Admin):
choco install jq -y - Ubuntu / Debian / WSL:
sudo apt update && sudo apt install -y jq - macOS:
brew install jq
- Windows (PowerShell as Admin):
🚀 Running the CLI
Option A: Direct Execution via curl
Using Git Bash / Linux / macOS:
curl -sSL https://git.oslog.pro/dandy/osmap_cli/raw/branch/main/osmap-embed.sh | bash
To pass arguments / flags:
# Open Executive Map directly in browser
curl -sSL https://git.oslog.pro/dandy/osmap_cli/raw/branch/main/osmap-embed.sh | bash -s -- executive --env live --open
# Get all embed URLs for beta environment
curl -sSL https://git.oslog.pro/dandy/osmap_cli/raw/branch/main/osmap-embed.sh | bash -s -- all --env beta
Using Windows PowerShell:
bash -c "curl -sSL https://git.oslog.pro/dandy/osmap_cli/raw/branch/main/osmap-embed.sh | bash"
Option B: Clone & Run Locally
git clone https://git.oslog.pro/dandy/osmap_cli.git
cd osmap_cli
chmod +x osmap-embed.sh
# Launch Interactive Menu
./osmap-embed.sh
📖 Usage & Commands
./osmap-embed.sh [route|command] [options]
Commands
| Command | Description |
|---|---|
interactive (default) |
Opens an interactive CLI menu to pick routes, copy tokens, or switch environments |
all |
Prints a formatted table of all map embed URLs with a valid token |
token |
Fetches and prints the raw active access token only |
validate |
Checks whether the locally cached token is still valid |
revoke |
Revokes active tokens on the server and clears local cache |
register |
Registers a new application and saves credentials |
Available Map Routes
| Route Identifier | Map Name | Target Path |
|---|---|---|
executive |
Executive Map | /executive |
rolling |
Rolling Map | /rolling |
iris-jpl |
IRIS JPL | /iris-jpl |
iris-jpl-v2 |
IRIS JPL (v2) | /v2/iris-jpl |
accelerometer |
Executive Accelerometer | /executive/accelerometer |
genset |
Genset Monitoring | /genset |
managerial |
Managerial / Asset View | /managerial |
fatigue |
Fatigue Monitoring | /fatigue |
sigap-tracker |
SIGAP Tracker | /sigap-tracker |
sigap-dashboard |
SIGAP Dashboard | /sigap-dashboard |
railway-cargo-system |
Railway Cargo System (RCS) | /railway-cargo-system |
⚙️ Options & Flags
| Flag | Description | Default |
|---|---|---|
-e, --env <env> |
Target environment (live, beta, staging, demo, local, or custom URL) |
live |
-o, --open |
Automatically open the generated URL in your default browser | false |
-c, --copy |
Automatically copy the URL to system clipboard | false |
--app-id <id> |
Override App ID credential | Default Built-in / Env |
--app-secret <sec> |
Override App Secret credential | Default Built-in / Env |
--save |
Save provided --app-id and --app-secret to .osmap_credentials |
false |
-h, --help |
Show command line help and usage | - |
💡 Examples
-
Interactive Menu (live environment):
./osmap-embed.sh -
Open IRIS JPL in browser on Live environment:
./osmap-embed.sh iris-jpl --open -
Get the raw token string for scripts / automation:
TOKEN=$(./osmap-embed.sh token --env live) echo "Current Token: $TOKEN" -
Open Managerial Map on Beta environment:
./osmap-embed.sh managerial --env beta --open -
Test against Local development server (
http://localhost:8000):./osmap-embed.sh --env local
🔐 Credentials & Configuration Precedence
Credentials are automatically loaded in the following order:
- CLI Flags (
--app-id,--app-secret) - Environment Variables (
OSMAP_APP_ID,OSMAP_APP_SECRET) - Local config file (
.osmap_credentials) - Current directory
.envfile - Built-in default credentials