This release is a pre-release and may not be stable for production use.
BOSA CLI
A command-line interface for managing BOSA integrations and authentication.
Prerequisites
Prerequisites details
-
Python v3.11 or above (to run
python)- Using Conda (recommended): You can use Miniconda to install and manage Python versions.
-
BOSA API access (contact your administrator for credentials)
Installation
Install the CLI using:
pip install bosa-cli
Quick Start
Get up and create your first integration using BOSA CLI:
-
Login:
bosa auth login # Make sure you have access to bosa playground environment. # You will be prompted to enter: # Client API Key: sk-client-... # Username (User Identifier): your user identifier # User Secret: sk-user-...
-
View Available Integrations:
bosa integrationsYou should have 0 integration(s) count for each connector listed.
-
Add Your First Integration:
bosa integrations add github
You should see the following message:
✓ OAuth flow initiated for github! Please visit the following URL to complete the integration: https://github.com/login/oauth/authorize?client_id=...Open the URL in your browser and follow the OAuth flow.
-
Check your GitHub accounts:
After you have completed the OAuth flow, you can check your GitHub accounts.
bosa integrations show github
Voila! You should see your GitHub accounts listed, as shown below:
Integrations for github ======================= ℹ Found 1 integration(s) User Identifier | Status ------------------------------------ | your-github-username | ✓ Selected
That's it! You're now ready to manage your BOSA integrations.
Command Reference
Authentication Commands
| Command | Description | Options |
|---|---|---|
bosa auth login |
Authenticate with client credentials | --api-url <url> |
bosa auth status |
Check current authentication status | - |
bosa auth logout |
Clear stored credentials | - |
Login prompts:
- Client API Key: Your client API key (input hidden)
- Username: Your user identifier
- User Secret: Your user secret (input hidden)
Configuration Options:
--api-url: Custom BOSA API URL (for development purposes)
Integration Commands
| Command | Description | Parameter(s) |
|---|---|---|
bosa integrations |
List all connectors and integration counts | - |
bosa integrations list |
Same as above (explicit) | - |
bosa integrations add <connector> |
Add new integration via OAuth flow | <connector>: github, google, etc. |
bosa integrations show <connector> |
Show all accounts for a connector | <connector>: github, google, etc. |
bosa integrations show <connector> <identifier> |
Show specific integration details | <connector>: github, google, etc. <identifier>: email/username |
bosa integrations remove <connector> <identifier> |
Remove specific integration | <connector>: github, google, etc. <identifier>: email/username |
bosa integrations select <connector> <identifier> |
Set integration as primary | <connector>: github, google, etc. <identifier>: email/username |
Examples:
bosa integrations # List all connectors
bosa integrations add github # Add GitHub integration
bosa integrations show google # Show all Google accounts
bosa integrations show google user@gmail.com # Show specific account details
bosa integrations remove github username # Remove GitHub integration
bosa integrations select google user@gmail.com # Set as primary Google account
User Commands
| Command | Description | Parameter(s) |
|---|---|---|
bosa users create <identifier> |
Create a new user account | <identifier>: email/username |
Example:
bosa users create john.doe@example.com
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.
Getting Help
Get help for any command:
bosa --help # Main help
bosa auth --help # Authentication commands help
bosa integrations --help # Integration commands help
bosa users --help # User management commands help
Available Connectors
The available connectors depend on your BOSA API configuration. Common connectors include:
- github: GitHub API integration
- google: Google services integration
- google_drive: Google Drive integration
- google_docs: Google Docs integration
- google_mail: Google Mail integration
Contributing
We welcome contributions! Please see our documentation:
- CONTRIBUTING.md - Development setup, workflow, and code review guidelines
- constitution.md - Code generation standards
License
This project is maintained by the BOSA Engineering Team.
Metadata
Release files for gl-connector-cli 0.0.1b1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| gl_connector_cli-0.0.1b1.tar.gz | 24.6 kB | Without provenance | Details for gl_connector_cli-0.0.1b1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| gl_connector_cli-0.0.1b1-py3-none-any.whl | Python 3 | none | any | Details for gl_connector_cli-0.0.1b1-py3-none-any.whl |
Total release size: 49.3 kB
Release files / gl_connector_cli-0.0.1b1.tar.gz
| Download URL | gl_connector_cli-0.0.1b1.tar.gz |
|---|---|
| Size | 24.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3044ae2e1242c5726f01ab53755ec1d2e826a0c8442ad1428c05f48866b27a37
|
|
BLAKE2b-256 checksum How to use checksums |
de03276243ac27e28bd78b186ff324572697098d09db0c274e478d3270c34a86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.16
|
Release files / gl_connector_cli-0.0.1b1-py3-none-any.whl
| Download URL | gl_connector_cli-0.0.1b1-py3-none-any.whl |
|---|---|
| Size | 24.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56ed5cc5c5495a3c2189ff2a438b201404e1c7e1baa24603803fb6d4e0579095
|
|
BLAKE2b-256 checksum How to use checksums |
3f5c74eaa4ec8ae03dff57310f3e7f644c7b17c9433b42968fa255ce5bb92d68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.16
|
Security for gl-connector-cli 0.0.1b1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.