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:
wasp <command> [command-args]
new <project-name> Creates new Wasp project.
version Prints current version of CLI.
waspls Run Wasp Language Server. Add --help to get more info.
completion Prints help on bash completion.
uninstall Removes Wasp from your system.
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.
deploy Deploys your Wasp app to cloud hosting providers.
telemetry Prints telemetry status.
deps Prints the dependencies that Wasp uses in your project.
dockerfile Prints the contents of the Wasp generated Dockerfile.
info Prints basic information about current Wasp project.
wasp new MyApp
wasp db migrate-dev
Discord (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
wasp uninstallremoves Wasp from your system.
$ wasp uninstall
🐝 --- Uninstalling Wasp ... ------------------------------------------------------
We will remove the following directories:
We will also remove the following files:
Are you sure you want to continue? [y/N]
✅ --- Uninstalled Wasp -----------------------------------------------------------
To setup Bash completion, execute
wasp completion and follow the instructions.
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
src/to automatically reflect in the browser. It also shows messages from the web app, the server and the 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 deploymakes it easy to get your app hosted on the web. Currently, Wasp offers support for Fly.io. Want another hosting provider? Let us know in Discord or make a PR by updating this TypeScript app!
wasp telemetryprints telemetry status.
$ wasp telemetry
Telemetry is currently: ENABLED
Telemetry cache directory: /home/user/.cache/wasp/telemetry/
Last time telemetry data was sent for this project: 2021-05-27 09:21:16.79537226 UTC
Our 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.
- Supports a
--name foooption for providing a migration name, as well as
--create-onlyfor creating an empty migration but not applying it.
- Supports a
wasp db studioopens the GUI for inspecting your database.