@compas/cli

@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.

Changelog

v0.7.0

Introducing the experimental zakmes CLI for an integrated development experience! Installable via the compas package. See the docs for more information and follow the issue to stay up to date.

Features

• feat(eslint-plugin): add 'node-builtin-module-url-import' rule 923e7b
  • Auto-fixes any import of Node.js builtins you use the node: specifier.

Other

• docs(stdlib): minor insight event documentation improvement (#2728) 9a8afc
• chore(docs): use vitepress sitemap feature 28fcb1
• chore: cleanup code-mods c80410
• chore: typescript maintenance 7b3e0f
• chore(release): fail release if types don't check out fb4e4d
• chore(docs): customize vitepress theme to use green colors ba082d
• chore(typescript): remove tsc from the internal generate command c3ab53
• chore(dependabot): group all dependency updates b7186e

Dependency updates

• build(deps): bump sharp from 0.32.3 to 0.32.5 (#2743, #2799)
  • Release notes
• build(deps): bump c8 from 8.0.0 to 8.0.1 (#2753)
  • Release notes
• build(deps): bump pino from 8.14.1 to 8.15.0 (#2757, #2779)
  • Release notes
• build(deps): bump eslint-plugin-jsdoc from 46.4.4 to 46.4.6 (#2758, #2778)
  • Release notes
• build(deps): bump eslint-config-prettier from 8.8.0 to 9.0.0 (#2759, #2773, #2777)
  • Major version bump
• build(deps): bump eslint-plugin-import from 2.27.5 to 2.28.1 (#2761, #2804)
  • Release notes
• build(deps): bump eslint from 8.45.0 to 8.47.0 (#2760, #2792)
  • Release notes
• build(deps): bump @aws-sdk/client-s3 from 3.374.0 to 3.395.0 (#2770, #2783, #2804)
  • Release notes
• build(deps): bump @aws-sdk/lib-storage from 3.374.0 to 3.395.0 (#2770, #2783, #2804)
  • Release notes
• build(deps): bump prettier from 3.0.0 to 3.0.2 (#2772, #2798)
  • Release notes
• build(deps): bump @babel/core from 7.22.9 to 7.22.10 (#2781)
  • Release notes
• build(deps): bump @babel/eslint-parser from 7.22.9 to 7.22.10 (#2781)
  • Release notes
• build(deps): bump recast from 0.23.3 to 0.23.4 (#2790)
  • Release notes
• build(deps): bump bcrypt from 5.1.0 to 5.1.1 (#2797)
  • Release notes
• build(deps): bump cron-parser from 4.8.1 to 4.9.0 (#2795)
  • Release notes
• build(deps): bump dotenv from 16.0.3 to 16.3.1 (#2804)