GL Connectors CLI

Command-line interface for working with BOSA ecosystem tools and services.

Note that we are currently in the process of migrating from "BOSA Connector" to "GL Connector"; some inconsistencies may appear during this time. For example, the library name may still be bosa-connectors-binary or bosa-cli, simply to ensure functionality while we need to do the big migration for the libraries and endpoints. Please bear with us as we navigate these new changes.

bosa-cli is the official command-line tool designed to streamline operations, automation, and integrations within the GL Connectors ecosystem. It provides commands for authentication, service registration, project bootstrapping, plugin management, and more.

Installation

From PyPIi:

pip install bosa-cli

Quick Start

Authentication

First, authenticate with your credentials:

bosa auth login

You'll be prompted for:

• Client API Key: Your client API key (input will be hidden)

• Username: Your user identifier

• User Secret: Your user secret (input will be hidden)

By default, You will be log in to production https://api.bosa.id

For testing or custom URL, please use --api-url flag

Authentication with custom URL:

bosa auth login --api-url http://localhost:8000

Check authentication status:

bosa auth status

Logout and clear session:

bosa auth logout

Commands

Authentication

The bosa auth command manages your authentication credentials and session with the GL Connector's API Platform. All CLI operations require authentication, so this is typically the first command you'll use.

Login

Authenticate with your Connectors credentials to start using the CLI.

Usage:

bosa auth login [--api-url <url>]

Options:

• --api-url <url> - Custom Connectors API URL (default: https://api.bosa.id)

Interactive Prompts:

• Client API Key - Your client API key (format: sk-client-*, input hidden)

• Username - Your user identifier

• User Secret - Your user secret (input hidden)

Examples:

# Login to production
bosa auth login

# Login to local development environment
bosa auth login --api-url http://localhost:8000

# Login to staging environment
bosa auth login --api-url https://staging-api.bosa.id

Status Check

Check your current authentication status and session information.

Usage:

bosa auth status

Examples:

bosa auth status

# Output:
# Authentication Status
# =====================
# Username: ..
# API URL: http://localhost:8000

Logout

Clear your stored authentication session and credentials.

Usage:

bosa auth logout

Output:

✓ Successfully logged out # Success

Notes:

• API URL is stored with the session and used for all subsequent commands

• Always use bosa auth logout when switching between environments or when done working

---

Integration Management

List all available connectors and their integration status:

bosa integrations
# or
bosa integrations list

This shows a simple table with:

• Connector: Name of each available connector

• Integrated: ✓ if you have integrated with that connector, ✗ if not

Add a new integration (initiates OAuth flow):

bosa integrations add github
bosa integrations add google

Show all accounts for a specific connector:

bosa integrations show google
bosa integrations show github

This displays:

• Number of integrations found

• Table showing account identifiers for each integration

Remove a specific integration:

bosa integrations remove github [e-mail]
bosa integrations remove google [e-mail]

User Management

Create a new user:

bosa users create [e-mail]

Important: Save the user secret securely! It's only shown once.

Configuration

The CLI stores configuration in ~/.bosa/config.json. This file contains:

• Authentication session (client key, user token, API URL)

• Session expiration information

The API URL is only configurable during authentication using the --api-url flag.