overview
Psychic and Dream both provide a cli for interfacing with underlying bin scripts. These scripts are useful for doing things like database operations, syncing types, listing your routes, etc... To see the available list of commands, you can use the --help flag:
yarn psy --help
Usage: cli|generate:dream [options] [command] <name>
generate:model <name> [...attributes] create a new dream
Arguments:
name name of the dream
Options:
--tsnode runs the command using ts-node instead of node
-h, --help display help for command
Commands:
dream [options] calls to the underlying dream cli
build builds the underlying dream and psychic apps
spec [options] runs all specs if no spec is provided. If a spec is provided, it will run that
spec.
clean cleans up existing test infrastructure from psychic and dream installations
generate:migration|g:migration [options] <name> g:migration <name> create a new dream migration
generate:resource|g:resource [options] <route> <modelName> generate:resource <name> [...attributes] create a new dream, migration,
controller, and serializer
generate:controller|g:controller [options] <route> generate:controller <route> [...methods] create a new controller, autodefining
method stubs for passed methods
generate:serializer|g:serializer [options] <name> generate:serializer <name> [...attributes] create a new serializer
sync:client [options] sync api routes and schema to client application
sync:client:routes [options] sync:client:routes generates a copy of the routes file that is consumable by
your client application.
sync:client:schema [options] sync:client:schema generates schema from serializers for client application
sync|sync:schema [options] runs yarn dream sync
routes [options] examines your current models, building a type-map of the associations so that
the ORM can understand your relational setup. This is commited to your repo, and
synced to the dream repo for consumption within the underlying library.
sync:routes [options] reads the routes generated by your app and generates a cache file, which is then
used to give autocomplete support to the route helper, amoongst other things.
db:migrate [options] db:migrate runs any outstanding database migrations
db:reset [options] db:reset drops, creates, migrates, and seeds database, followed by a type sync
db:create [options] creates a new database, seeding from local .env or .env.test if NODE_ENV=test is
set for env vars
db:drop [options] drops the database, seeding from local .env or .env.test if NODE_ENV=test is set
for env vars
db:rollback [options] rolls back your migrations, traveling back the number of steps specified
db:seed [options] seeds the database
console [options] initiates a repl, loading the models from the development test-app into scope
for easy use