Commands per stack
Every page of this guide writes seampact <command>. This page gives the line to type for your stack. Run it in the app folder.
| Command | Node (npm) | Gradle | Maven | PHP | Python | Compiler binary |
|---|---|---|---|---|---|---|
init |
npx seampact init |
not available | not available | not available | not available | not available |
generate |
npx seampact generate |
./gradlew seampactGenerate (./gradlew build runs it) |
./mvnw generate-sources (verify runs it) |
vendor/bin/seampact generate |
seampact generate |
not available |
check |
npx seampact check |
./gradlew seampactCheck (./gradlew check runs it) |
./mvnw verify |
vendor/bin/seampact check |
seampact check |
not available |
lint |
npx seampact lint |
use the binary | use the binary | use the binary | use the binary | seampact lint |
diff |
npx seampact diff --against <baseline> |
use the binary | use the binary | use the binary | use the binary | seampact diff --against <baseline> |
bundle |
npx seampact bundle |
use the binary | use the binary | use the binary | use the binary | seampact bundle |
- Without Node, the compiler binary runs
compile,lint,diff,explainandbundle. It has noinit,generateorcheck. initwrites the config and an example contract. On the other stacks, writeseampact.config.yamlby hand: the config file shows how.- Laravel also runs
php artisan seampact:generate. Symfony runsbin/console seampact:generateafter you list its commands bundle. Django runspython manage.py seampact_generateandpython manage.py seampact_check. - On Maven, the plugin runs
generatebefore the compile andcheckinverify. On Gradle,./gradlew checkalso runsseampactCheck. - The Python
seampactcommand hasgenerateandcheckonly. It reads a bundle, which you make withbundle.
Where each stack writes the generated files: Generated files. To run check in CI: Check in CI.