GitGlue CLI Documentation
Command-line interface for GitGlue. Create backups, generate documentation, manage commits, and handle your repositories from the terminal.
Installation
Install it using this simple install script
curl -fsSL https://install.gitglue.com/cli/0.8.6-beta.5/install.sh | sudo bash
Version 0.8.6-beta.5
GitGlue CLI is actively developed with regular updates. Check the changelog for the latest features and improvements.
Authentication
Connect your CLI to GitGlue cloud services to access backups and manage repositories.
gitglue auth login
# or
gg auth login
gitglue auth status
# or
gg auth status
Account Required
Authentication is required for GitGlue cloud services. Documentation generation and smart commits work without an account.
Available Commands
Command Aliases
You can use either gitglue or gg to run any command. Both are equivalent and interchangeable.
Authentication
Connect your CLI to GitGlue cloud services for enhanced functionality.
Documentation Generation
Generate comprehensive documentation for your codebase with flexible options.
Smart Commit Messages
Generate intelligent commit messages based on your changes with interactive file selection.
Repository Inspection
Comprehensive Git repository analysis with branch comparison and commit history.
Status Check
Quick repository status check with GitGlue integration and basic information display.
Documentation Generation
gitglue generate docs --file {path_to_file}
Alias: gg generate docs --file {path_to_file}
Generate documentation for a specific file. The path can be relative or absolute.
→ Generating documentation for: src/components/Button.tsx
✓ Documentation generated successfully
gitglue generate docs
Alias: gg generate docs
Scan the entire current directory and subdirectories (respecting .gitignore) and generate documentation for all files.
→ Scanning directory...
→ Found 25 files (respecting .gitignore)
→ Generating documentation...
✓ Documentation generated for 25 files
gitglue generate docs --clean
Alias: gg generate docs --clean
Generate clean documentation by removing comments from the output. Can be combined with --file option.
→ Scanning directory with clean mode...
→ Removing comments from output...
✓ Clean documentation generated
Tip: Use --clean when you want documentation without code comments for cleaner, more focused output.
gitglue generate docs --clean --file {path_to_file}
Alias: gg generate docs --clean --file {path_to_file}
Generate clean documentation for a specific file, removing comments from the output.
→ Generating clean documentation for: src/utils/helpers.ts
→ Removing comments...
✓ Clean documentation generated
No Account Required
Documentation generation works without a GitGlue account. Supports 15+ file types with intelligent code analysis and multiple documentation levels.
Smart Commit Messages
gitglue commit
Alias: gg commit
Generate an intelligent commit message by analyzing all staged changes. The CLI will consider file diffs and provide contextual commit messages.
→ Analyzing staged changes...
→ Found 3 modified files
✓ Commit message generated: "feat: add user authentication and validation"
✓ Commit created successfully
gitglue commit --interactive
Alias: gg commit --interactive
Launch an interactive mode to select specific files for commit. You can choose to commit all files or select individual files from a list.
→ Found 5 modified files:
[1] src/components/Button.tsx
[2] src/utils/auth.ts
[3] src/pages/login.tsx
[4] package.json
[5] README.md
→ Select files to commit (space to select, enter to confirm):
✓ Selected: Button.tsx, auth.ts, login.tsx
✓ Commit message: "feat: implement user authentication flow"
Smart Features
The commit command intelligently analyzes your code changes and generates meaningful commit messages that follow conventional commit standards.
Repository Inspection
gitglue inspect
Alias: gg inspect
Comprehensive Git repository analysis with branch comparison, commit history, and working directory status.
→ Current branch: main
→ Local branches: main, feature/auth, bugfix/login
→ Remote branches: origin/main, origin/develop
→ Branch comparison: 3 commits ahead, 1 behind main
→ Recent commits: 5 commits in last 7 days
✓ Repository analysis complete
No Account Required
Repository inspection works without a GitGlue account. Provides comprehensive Git repository analysis and visual branch trees.
Status Check
gitglue status
Alias: gg status
Quick repository status check with GitGlue integration and basic information display.
→ Repository: /path/to/your/repo
→ Branch: main
→ GitGlue: Welcome to GitGlue CLI!
✓ Status check complete
No Account Required
Status check works without a GitGlue account. Provides basic repository information and GitGlue integration status.
Getting Started
Install the CLI
Use the install script to install GitGlue CLI globally on your system.
Authenticate (Optional)
Connect to GitGlue cloud services using gitglue auth login or gg auth login for enhanced functionality.
Navigate to Your Repository
Open your terminal and navigate to the Git repository you want to work with.
Run Your First Command
Try generating documentation with gitglue generate docs or gg generate docs to get started.
Ready to Get Started?
Install GitGlue CLI and start automating your Git workflows from the command line. Documentation generation and smart commits work immediately without an account.