Commands Overview - Developer Guide

Gleef CLI provides a simple set of commands to manage your translation workflow. Each command is designed to handle a specific aspect of the localization process.

Available Commands

gleef init

Initialize Gleef in your project by detecting locale files and creating configuration

gleef login

Authenticate with Gleef using your API key

gleef push

Push new and updated translation keys to Gleef

gleef translate

Generate AI translations and merge them back into your local files

gleef pull

Get the latest translations from Gleef and update local files

Command Reference

Core Commands

Command	Purpose	When to Use
`gleef init`	Project setup	First time setting up Gleef in a project
`gleef login`	Authentication	When setting up CLI or changing API keys
`gleef push`	Upload local translations	Standard command to send new and modified keys to Gleef
`gleef translate`	AI-powered translation with local merge	When you want to generate AI translations and write them back into your local files
`gleef pull`	Sync translations	When you want to get latest translations from your team

Global Flags

All commands support these global flags:

Flag	Description
`--help`	Show help information for the command
`--version`	Display the CLI version

Getting Help

Get help for any command using the --help flag:

gleef --help              # General help
gleef init --help         # Help for init command
gleef push --help         # Help for push command
gleef translate --help    # Help for translate command
gleef pull --help         # Help for pull command

You can also use the dedicated help command:

gleef help                # General help
gleef help init           # Help for init command
gleef help push           # Help for push command
gleef help translate      # Help for translate command
gleef help pull           # Help for pull command

Command Workflow

Here’s the typical workflow using Gleef CLI commands:

Initial Setup

gleef login              # Authenticate once
gleef init               # Set up project configuration

Push New Content

gleef push               # Send new and updated keys to Gleef

Sync Updates

gleef pull               # Get latest translations

Ongoing Development

gleef push               # Upload changes
gleef pull               # Sync updates

Command Examples

Basic Usage

# Set up a new project
gleef init

# Push translations to Gleef
gleef push

# Get latest translations
gleef pull

Advanced Usage

# Push only specific keys matching a pattern (regex)
gleef push --match "^button\."

# Get all translations including new keys
gleef pull --add-new

# Check for new translations without updating
gleef pull --check

# Skip review process and publish immediately
gleef push --skip-review

Error Handling

All commands provide clear error messages and exit codes:

Exit code 0: Command completed successfully
Exit code 1: Command failed with an error

Common error scenarios:

Authentication errors: Run gleef login to re-authenticate
Configuration errors: Check your .gleef/config.json file
Network errors: Verify your internet connection and API access
File errors: Ensure your locale files are properly formatted

Next Steps

Workflow Guide

Learn best practices for using these commands together

Configuration

Customize CLI behavior with configuration options

​Available Commands

gleef init

gleef login

gleef push

gleef translate

gleef pull

​Command Reference

​Core Commands

​Global Flags

​Getting Help

​Command Workflow