@compas/cli
CLI to help with your local development environment, testing and more. Take a
look at the documentation.
Reference
For the full reference, view the
documentation. Below is the short
reference, generated via compas help
.
Usage: compas COMMAND
The Compas CLI
Unified backend tooling.
Examples:
- compas docker up
- compas lint --jsdoc
- compas visualise erd --generated-directory ./src/generated
References:
- Docs: https://compasjs.com
- Source: https://github.com/compasjs/compas
- Issues: https://github.com/compasjs/compas/issues
Commands:
check-env Various checks helping with a better Compas experience.
code-mod Execute code-mods to help migrating to new Compas versions.
completions Configure shell auto-complete for this CLI.
docker Manage common docker components.
help Display help for any of the available commands.
init Init various files in the current project.
lint Lint all project files.
migrate Run PostgreSQL migrations via the @compas/store migration system.
run Run arbitrary JavaScript files, scripts defined in the package.json and scripts located in the scripts directory.
test Run all tests in your project.
version Print the installed Compas version and exit
visualise Visualise various code-generated structures.
watch Run the command, restarting it when file changes happen.
Flags:
-h, --help Display information about the current command. (boolean)
Run 'compas help COMMAND' for more information of a specific sub command.