Gradle Cheat Sheet

Gradle cheat sheet with real commands and snippets for setup, core workflows, debugging, and production-safe automation patterns. If you are working across tools, pair this with the Java Cheat Sheet and Maven Cheat Sheet.

Setup and Installation

Goal: Verify installation and CLI metadata

# Resolve command path from current shell
command -v gradle

# Print installed version to confirm runtime
gradle --version

# Read top-level help before using subcommands
gradle --help

Goal: Install or upgrade the tool on a workstation

# Install package with Homebrew on macOS
brew install gradle

# Upgrade to the latest available package
brew upgrade gradle

# Re-check version after upgrade
gradle --version

Goal: Run day-to-day commands

# List available Gradle tasks
./gradlew tasks

# Run project tests
./gradlew test

# Build distributable artifacts
./gradlew build

# Inspect dependency graph
./gradlew dependencies

Core Workflows

Goal: Capture command help for quick offline lookup

# Create docs folder for generated command references
mkdir -p docs/cli

# Write help output to a timestamped file
gradle --help > docs/cli/gradle-help.txt

# Search help output for a keyword
rg "config|auth|deploy" docs/cli/gradle-help.txt

Goal: Wrap repetitive commands in a script

# Create scripts directory for local automation
mkdir -p scripts

# Write repeatable health-check script
cat > scripts/check-gradle.sh <<'SH'
#!/usr/bin/env bash
set -euo pipefail
gradle --version
gradle --help >/dev/null
SH

# Make script executable and run it
chmod +x scripts/check-gradle.sh && ./scripts/check-gradle.sh

Configuration and Environment

Goal: Pin environment variables for predictable runs

# Define environment profile for local commands
export GRADLE_PROFILE=dev

# Persist profile in local shell configuration
echo 'export GRADLE_PROFILE=dev' >> ~/.zshrc

# Reload shell profile changes
source ~/.zshrc

Automation and CI

Goal: Add tool checks to CI pipeline

# Run lint/test/build in strict mode
set -euo pipefail

# Verify CLI exists before invoking workflow
command -v gradle

# Exit quickly if command is unavailable
gradle --version

Debugging and Troubleshooting

Goal: Collect diagnostics when commands fail

# Capture command output and exit code
gradle --help > /tmp/gradle-debug.log 2>&1; echo $?

# Inspect captured diagnostics
tail -n 80 /tmp/gradle-debug.log

# Check current shell PATH entries
echo $PATH | tr ':' '\n'

Common Gotchas

• Pin Gradle versions in CI so local and pipeline behavior match.
• Check tool authentication context before running write or deploy commands.
• Prefer non-interactive flags in scripts to avoid stalled jobs.
• Capture stderr logs in CI artifacts for faster incident triage.
• Keep secrets in environment variables, not committed scripts.

Related Sheets

• Java Cheat Sheet — daily Java commands and production-ready examples.
• Maven Cheat Sheet — daily Maven commands and production-ready examples.
• curl Cheat Sheet — daily curl commands and production-ready examples.