Skip to main content

A CLI tool to facilitate the developer workflow

Project description

Glu CLI

PyPI - Version GitHub CI

Glu CLI is a command‑line interface for Glu that streamlines common development workflows by integrating GitHub pull requests, Jira tickets, and AI‑powered content generation.

Installation

Glu CLI is distributed via PyPI. You can install it with:

pipx install glu-cli

Alternatively, to install from source:

git clone https://github.com/BrightNight-Energy/glu.git
cd glu
pip install -e .

Usage

After installation, the glu command will be available:

glu --help

Commands

Glu CLI provides two main command groups: pr and ticket. They are registered as subcommands of the main CLI:

glu pr --help
glu ticket --help

pr create

The only command you need. When you're ready to push and raise a PR, use this. It will:

  1. Create your commit message based on commit diff (if uncommitted changes)
  2. Create a ticket in Jira based on PR description (or use the provided ticket #)
  3. Push a PR based on the git diff and tag your reviewers
  4. If PR is not a draft, will move your ticket to Ready for review!

...all fully customizable and within your control.

glu ticket creation demo

glu pr create [OPTIONS]

Options:

  • --ticket, -t TEXT Jira ticket number
  • --project, -p TEXT Jira project (defaults to default project)
  • --draft, -d Mark as draft PR
  • --ready-for-review/--no-ready-for-review Transition ticket to Ready for review
  • --reviewer, -r TEXT Requested reviewers (repeatable)
  • --provider, -pr TEXT AI model provider

ticket create

Create a Jira ticket, optionally using AI to generate summary and description:

glu ticket creation demo

glu ticket create [OPTIONS]

Options:

  • --summary, --title, -s TEXT Issue summary or title
  • --type, -t TEXT Issue type
  • --body, -b TEXT Issue description
  • --assignee, -a TEXT Assignee
  • --reporter, -r TEXT Reporter
  • --priority, -y TEXT Priority
  • --project, -p TEXT Jira project
  • --ai-prompt, -ai TEXT AI prompt to generate summary and description
  • --provider, -pr TEXT AI model provider

The command also accepts additional JIRA fields via --<field> <value>.

Configuration (init)

Initialize your Glu configuration interactively:

glu init

Options:

  • Jira Config

    • --jira-api-token TEXT Jira API token (required)
    • --jira-email, --email TEXT Jira email (required)
    • --jira-server TEXT Jira server URL (default: https://jira.atlassian.com)
    • --jira-in-progress TEXT Jira “in progress” transition name (default: Starting)
    • --jira-ready-for-review TEXT Jira “ready for review” transition name (default: Ready for review)
    • --default-jira-project TEXT Default Jira project key
  • GitHub Config

    • --github-pat TEXT GitHub Personal Access Token (required)
  • OpenAI Config

    • --openai-api-key TEXT OpenAI API key (required)
    • --openai-org-id TEXT OpenAI organization ID (required)
  • Glean Config

    • --glean-api-token TEXT Glean API token
    • --glean-instance TEXT Glean instance URL

Contributing

Contributions to Glu CLI are welcome! Please follow these guidelines:

  1. Fork the repository and create your branch:
    git checkout -b feature/your-feature
    
  2. Make your changes, ensuring that new code includes tests where appropriate.
  3. Install precommit hooks:
     pre-commit install --install-hooks
     pre-commit install --hook-type commit-msg
    
  4. Commit your changes following Conventional Commits.
  5. Push to your fork and open a Pull Request.

Acknowledgements

Glu CLI is inspired by Jira CLI and GitHub CLI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glu_cli-1.6.0.tar.gz (977.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

glu_cli-1.6.0-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file glu_cli-1.6.0.tar.gz.

File metadata

  • Download URL: glu_cli-1.6.0.tar.gz
  • Upload date:
  • Size: 977.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.9

File hashes

Hashes for glu_cli-1.6.0.tar.gz
Algorithm Hash digest
SHA256 aa8f7af3ae9d1ede31a26493f93bbf3adfffe2689a5d14fb0790ab5cfb9e334f
MD5 77413c1240e34d440cbbd16f163aa6af
BLAKE2b-256 949a8e639ca95825e8c2f8fe6fcb13a785dbf36c75b53af8348fc9f07f9c2f31

See more details on using hashes here.

File details

Details for the file glu_cli-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: glu_cli-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.9

File hashes

Hashes for glu_cli-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f81e20a87914a01c1f3841a2b670bb8e8c3b3e7b8cd6d830771e5a0eb38c8b48
MD5 780ac97455e59dcdb191e370f1ae3366
BLAKE2b-256 b60e8632db9824fc5bec9c432a15c8a0da26d323c0be815f3755fafa5552631b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page