BOSA CLI
A command-line interface for managing BOSA integrations and authentication.
Installation
The CLI is included with bosa-core. Install it using:
pip install bosa-core
Usage
Authentication
First, authenticate with your client 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)
For development/testing with custom API URL:
bosa auth login --api-url http://localhost:8000
Check authentication status:
bosa auth status
Logout and clear session:
bosa auth logout
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 user@example.com
bosa integrations remove google john.doe@gmail.com
User Management
Create a new user:
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.
Examples
Complete workflow
-
Login with credentials:
bosa auth login # Enter your client API key, username, and user secret when prompted
-
View available integrations:
bosa integrations -
Add GitHub integration:
bosa integrations add github # Follow the OAuth flow in your browser
-
Check your GitHub accounts:
bosa integrations show github
-
Create a new user (if you have permissions):
bosa users create newuser@example.com
Development workflow
For local development:
# Login to local API
bosa auth login --api-url http://localhost:8000
# Check status
bosa auth status
# List integrations
bosa integrations
# Add local integration
bosa integrations add github
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
Help
Get help for any command:
bosa --help
bosa auth --help
bosa integrations --help
bosa users --help
Configuration Options
--api-url: Custom BOSA API URL (only available duringauth login)--verbose: Enable verbose output
Security Notes
- All credentials are stored securely in
~/.bosa/config.jsonwith restricted permissions (600) - User secrets are only displayed once during user creation
- Tokens expire based on server configuration
- API URL is stored in the session and used for subsequent commands
- Always keep your credentials secure and never share them
- Use
bosa auth logoutto clear stored credentials when done
Metadata
Release files for bosa-cli 0.0.1
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 |
|---|---|---|---|---|
| bosa_cli-0.0.1.tar.gz | 16.7 kB | Without provenance | Details for bosa_cli-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bosa_cli-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for bosa_cli-0.0.1-py3-none-any.whl |
Total release size: 40.6 kB
Release files / bosa_cli-0.0.1.tar.gz
| Download URL | bosa_cli-0.0.1.tar.gz |
|---|---|
| Size | 16.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f5ed1c458b9db9fe7710b7c5c86e8f512b2aec495ada3d61b1498d75730876f
|
|
BLAKE2b-256 checksum How to use checksums |
73d946a65cc982a6b474abbee3ed8f373c81e134d9c2f33b99a6b106459829f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
poetry/2.1.1 CPython/3.12.0 Linux/5.10.0-32-cloud-amd64
|
Release files / bosa_cli-0.0.1-py3-none-any.whl
| Download URL | bosa_cli-0.0.1-py3-none-any.whl |
|---|---|
| Size | 23.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f4d2c62d8a3deddb9364000a5bc2f098ab1488997cd64db5d4f86d11edb133f5
|
|
BLAKE2b-256 checksum How to use checksums |
cd2e5c0d436d44fb31a6bba4ae973b8a654dd7e5d0012aa25dd101db0eeb2b25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
poetry/2.1.1 CPython/3.12.0 Linux/5.10.0-32-cloud-amd64
|
Security for bosa-cli 0.0.1
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.