leakcanary

(โ˜… 29,978)

A memory leak detection library for Android.

  • .editorconfig
  • .gitattributes
  • .gitignore
  • AGENTS.md
  • build.gradle.kts
  • CLAUDE.md
  • gradle.properties
  • gradlew
  • LICENSE.txt
  • mkdocs.yml
  • README.md
  • settings.gradle
  • shark-cli.sh

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/square/leakcanary

Downloads the entire project code from GitHub to your computer.

cd leakcanary

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r docs/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation