Subcommands66 subcommands
redwood dev
Start development servers for api and web
redwood deploy
Deploy your redwood project to a hosting provider target
redwood deploy aws
Deploy to AWS using the selected provider
redwood deploy netlify
Build command for Netlify deploy
redwood deploy render
Build (web) and Start (api) command for Render deploy
redwood deploy vercel
Build command for Vercel deploy
redwood destroy
Rollback changes made by the generate command
redwood destroy cell
Destroy a cell component
redwood destroy component
Destroy a component
redwood destroy function
Destroy a Function
redwood destroy layout
Destroy a layout component
redwood destroy page
Destroy a page and route component
redwood destroy scaffold
Destroy pages, SDL, and Services files based on a given DB schema Model
redwood destroy sdl
Destroy a GraphQL schema and service component based on a given DB schema Model
redwood destroy service
Destroy a service component
redwood generate
Save time by generating boilerplate code
redwood generate cell
Generate a cell component
redwood generate component
Generate a component component
redwood generate dataMigration
Generate a data migration component
redwood generate directive
Generate a directive
redwood generate function
Generate a Function
redwood generate layout
Generate a layout component
redwood generate page
Generate a page component
redwood generate scaffold
Generate Pages, SDL, and Services files based on a given DB schema Model. Also accepts <path/model>
redwood generate sdl
Generate a GraphQL schema and service object
redwood generate service
Generate a service component
redwood generate types
Generate types and supplementary code
redwood generate script
Generate a script that can use your services/libs to execute with redwood exec script <name>
redwood exec
Execute scripts generated by yarn redwood generate script to run one-off operations, long-running jobs, or utility scripts
redwood build
Build the api and web
redwood diagnostics
Get structural diagnostics for a Redwood project (experimental)
redwood console
Launch an interactive Redwood shell (experimental)
redwood info
Print your system environment information
redwood upgrade
Upgrade all @redwoodjs packages via an interactive CLI
redwood serve
Runs a server that serves both the api and the web sides
redwood type-check
Runs a TypeScript compiler check on both the api and the web sides
redwood test
Run Jest tests for api and web
redwood storybook
Starts Storybook locally
redwood lint
Lint your files
redwood open
Open your project in your browser
redwood setup
Initialize project config and install packages
redwood setup auth
Setup auth configuration for a provider
redwood setup custom-web-index
Setup an index.js file in web/src so you can customize how your Redwood App mounts to the DOM
redwood setup generator
SCopies a given generator's template files to your local app for customization. The next time you generate that type again, it will use your custom template instead of Redwood's default
redwood setup tsconfig
Setup tsconfig.json on both web and api sides
redwood setup deploy
Setup auth configuration for a provider
redwood data-migrate
Data migration tools
redwood prisma
Prisma commands
redwood prisma init
Setup Prisma for your app
redwood prisma generate
Generate artifacts (e.g. Prisma Client)
redwood prisma studio
Open Prisma Studio
redwood prisma format
Format your schema
redwood prisma migrate
Migrate your database
redwood prisma migrate dev
The migrate dev command updates your database using migrations files during development
redwood prisma migrate reset
Reset your database and apply all migrations, all data will be lost
redwood prisma migrate deploy
Apply pending migrations to update the database schema in production/staging
redwood prisma migrate resolve
Resolve issues with database migrations in deployment databases
redwood prisma migrate status
Check the status of your database migrations
redwood prisma migrate diff
Compares the database schema from two arbitrary sources, and outputs the differences either as a human-readable summary (by default) or an executable script
redwood prisma db
Manage your database schema and lifecycle (Preview)
redwood prisma db push
This command pushes the state of your Prisma schema file to the database without using migrations files
redwood prisma db seed
Seed your database
redwood prisma db execute
Execute native commands to your database
redwood prisma version
Print current version of Prisma components
redwood prisma version --json
Output JSON