This document describes the Wasp CLI commands, arguments, and options.
wasp command can be called from command line once installed.
When called without arguments, it will display its command usage and help document:
USAGE wasp <command> [command-args] COMMANDS GENERAL new <project-name> Creates new Wasp project. version Prints current version of CLI. IN PROJECT start Runs Wasp app in development mode, watching for file changes. db <db-cmd> [args] Executes a database command. Run 'wasp db' for more info. clean Deletes all generated code and other cached artifacts. Wasp equivalent of 'have you tried closing and opening it again?'. build Generates full web app code, ready for deployment. Use when deploying or ejecting. telemetry Prints telemetry status. deps Prints the dependencies that Wasp uses in your project. info Prints basic information about current Wasp project. EXAMPLES wasp new MyApp wasp start wasp db migrate-dev Docs: https://wasp-lang.dev/docsDiscord (chat): https://discord.gg/rzdnErX
wasp new <project-name>creates new Wasp project. A directory with the provided project-name will be created, containing boilerplate code.
$ wasp new MyFirstProject
wasp versionprints current version of CLI.
$ wasp version 0.2.0.1
wasp startruns Wasp app in development mode. It opens a browser tab with your application running, and watches for any changes to .wasp or files in ext/ to automatically reflect in the browser. It also shows messages from web app, server and database on stdout/stderr.
wasp cleandeletes all generated code and other cached artifacts. If using SQlite, it also deletes the SQlite database. It is the Wasp equivalent to "try shutting it down and turning back on".
$ wasp clean Deleting .wasp/ directory...Deleted .wasp/ directory.
wasp buildgenerates full web app code, ready for deployment. Use when deploying or ejecting. Generated code goes in the .wasp/build folder.
wasp telemetryprints telemetry status.
$ wasp telemetry Telemetry is currently: ENABLEDTelemetry cache directory: /home/user/.cache/wasp/telemetry/Last time telemetry data was sent for this project: 2021-05-27 09:21:16.79537226 UTCOur telemetry is anonymized and very limited in its scope: check https://wasp-lang.dev/docs/telemetry for more details.
wasp depsprints the dependencies that Wasp uses in your project.
wasp infoprints basic information about current Wasp project.
Wasp has a set of commands for working with the database. They all start with
db and mostly call prisma commands in the background.
wasp db migrate-devensures dev database corresponds to the current state of schema (entities): it generates a new migration if there are changes in the schema and it applies any pending migration to the database.
wasp db studioopens the GUI for inspecting your database.