Skip to content

samples.md

Latest commit

 

History

History
59 lines (39 loc) · 1.45 KB

samples.md

File metadata and controls

59 lines (39 loc) · 1.45 KB

Samples usage

This guide explains how to run the repository samples after they were moved out of the core library sources.

Where samples live

Runnable samples are in:

  • samples/src/main/java/examples/

The Maven Central artifact (io.github.deathbycaptcha:deathbycaptcha-java-library) contains only the core library.

If you only import the Maven dependency in another project, examples.* classes are not available there.

Build modes

  • Core library only (default):
mvn clean compile
  • Core library + samples (enable samples profile):
mvn -Psamples clean compile

Run a sample

Use -Psamples whenever you run a class from examples.*:

mvn -Psamples exec:java \
  -Dexec.mainClass="examples.ExampleGetBalance" \
  -Dexec.args="your_username your_password HTTP"

Socket API variant:

mvn -Psamples exec:java \
  -Dexec.mainClass="examples.ExampleGetBalance" \
  -Dexec.args="your_username your_password SOCKET"

Run Selenium sample

mvn -Psamples exec:java \
  -Dexec.mainClass="examples.ExampleSeleniumRecaptchaV2" \
  -Dselenium.headless=true

Common pitfalls

  • If you omit -Psamples, examples.* classes are not added to Maven sources and execution fails.
  • Editing samples does not change the published Maven Central artifact unless you also change core classes.
  • For production integrations, consume the core library API (com.DeathByCaptcha.*) instead of invoking sample classes.