Skip to main content

GL Connectors CLI

A command-line interface for managing GL Connectors integrations and authentication.

Prerequisites

Prerequisites details
  1. Python v3.12 or above (to run python)

    • Using Conda (recommended): You can use Miniconda to install and manage Python versions.
  2. Connector access (contact your administrator for credentials)

Installation

Install the CLI using:

pip install gl-connectors-cli

Quick Start

Get up and create your first integration using GL Connectors CLI:

  1. Login:

    glcon auth login
    # Make sure you have access to GL Connectors playground environment.
    # You will be prompted to enter:
    
    # Client API Key: sk-client-...
    # Username (User Identifier): your user identifier
    # User Secret: sk-user-...
    
  2. View Available Integrations:

    glcon integrations
    

    You should have 0 integration(s) count for each connector listed.

  3. Add Your First Integration:

    glcon 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.

  4. Check your GitHub accounts:

    After you have completed the OAuth flow, you can check your GitHub accounts.

    glcon integrations show github
    

    Voila! You should see your GitHub accounts listed, as shown below:

    Integrations for github
    =======================
    ℹ Found 1 integration(s)
    
    User Identifier | Selected | Auth Status
    ----------------------------------------
    | your-github-username | ✓ Selected | connected
    

That's it! You're now ready to manage your GL Connectors' integrations.

Command Reference

Authentication Commands

Command Description Options
glcon auth login Authenticate with client credentials --api-url <url>
glcon auth status Check current authentication status -
glcon 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 Connector URL (for development purposes)

Integration Commands

Command Description Parameter(s)
glcon integrations List all connectors and integration counts -
glcon integrations list Same as above (explicit) -
glcon integrations add <connector> Add new integration via OAuth flow <connector>: github, google, etc.
glcon integrations show <connector> Show all accounts for a connector <connector>: github, google, etc.
glcon integrations show <connector> <identifier> Show specific integration details <connector>: github, google, etc. <identifier>: email/username
glcon integrations remove <connector> <identifier> Remove specific integration <connector>: github, google, etc. <identifier>: email/username
glcon integrations select <connector> <identifier> Set integration as primary <connector>: github, google, etc. <identifier>: email/username

Examples:

glcon integrations                           # List all connectors
glcon integrations add github                # Add GitHub integration
glcon integrations show google               # Show all Google accounts
glcon integrations show google user@gmail.com  # Show specific account details
glcon integrations remove github username    # Remove GitHub integration
glcon integrations select google user@gmail.com # Set as primary Google account

User Commands

Command Description Parameter(s)
glcon users create <identifier> Create a new user account <identifier>: email/username

Example:

glcon users create john.doe@example.com

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

Configuration

The CLI stores configuration in ~/.connector/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:

glcon --help                    # Main help
glcon auth --help              # Authentication commands help
glcon integrations --help      # Integration commands help
glcon users --help             # User management commands help

Available Connectors

The available connectors depend on your Connector 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:

License

This project is maintained by the GL Connectors Team.

Metadata

Release files for gl-connectors-cli 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gl-connectors-cli 0.1.1
File Size Uploaded Provenance Actions
gl_connectors_cli-0.1.1.tar.gz 25.2 kB Without provenance Details for gl_connectors_cli-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gl-connectors-cli 0.1.1
File Interpreter ABI Platform Actions
gl_connectors_cli-0.1.1-py3-none-any.whl Python 3 none any Details for gl_connectors_cli-0.1.1-py3-none-any.whl

Total release size: 50.7 kB

Release files / gl_connectors_cli-0.1.1.tar.gz

Download URL gl_connectors_cli-0.1.1.tar.gz
Size 25.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fa3bfade7f40a8f82d35bf715972970941953075a34aa412c8b4a16a75bc2215
BLAKE2b-256 checksum
How to use checksums
85a145d68c143f743d8c75bb5f17650c13e9ef164caaa0a9c9edf6f7cfa44736
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"AlmaLinux","version":"8.10","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / gl_connectors_cli-0.1.1-py3-none-any.whl

Download URL gl_connectors_cli-0.1.1-py3-none-any.whl
Size 25.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a4e40e2486bb8f88445515ce3599aa89af7d36762379dc9157c901dd9f024b1
BLAKE2b-256 checksum
How to use checksums
b3b64850c99c615d13ffa4912aec5565d1a4a1ac298ea0e8b1df2a44478b90a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.4 {"installer":{"name":"uv","version":"0.13.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"AlmaLinux","version":"8.10","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for gl-connectors-cli 0.1.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page