Storm CLI is a command-line interface tool designed to streamline the development of server-side applications using the Storm framework. Inspired by the NestJS CLI, Storm CLI provides a powerful suite of commands to scaffold projects, generate boilerplate code, run development servers, and manage your application's lifecycle.
You can install Storm CLI using pip:
pip install storm-cliTo create a new Storm project, use the new command:
storm new my-storm-appThis command will scaffold a new Storm project in a directory named my-storm-app with a basic structure and initial setup.
Scaffolds a new Storm project.
storm new <project-name> [options]Options:
--skip-install: Skip installing dependencies.--template <template-name>: Use a specific project template.
Generates a new resource within the project.
storm generate <type> <name> [options]Types:
modulecontrollerserviceguardmiddlewareinterceptorfilterentityresource
Options:
--dry-run: Show what files would be created without actually creating them.--flat: Generate files without a nested folder.
Starts the application server for development.
storm serve [options]Options:
--port <port>: Specify the port to serve on (default: 3000).--watch: Restart the server on file changes.--debug: Run in debug mode for additional logging and debugging.
Builds the Storm application for production deployment.
storm build [options]Options:
--prod: Build in production mode.--output <directory>: Specify the output directory for the build files.
Runs the tests for the Storm application.
storm test [options]Options:
--watch: Run tests in watch mode.--coverage: Generate a code coverage report.--filter <pattern>: Run tests that match a specific pattern.
Lints the project’s code to enforce coding standards.
storm lint [options]Options:
--fix: Automatically fix linting errors where possible.--rules <rule-set>: Use a specific set of linting rules.
Manages database migrations.
storm migrate <subcommand> [options]Subcommands:
run: Applies pending migrations.revert: Reverts the last applied migration.create <name>: Creates a new migration file.status: Shows the current status of migrations.
Opens an interactive REPL session within the context of the application.
storm consoleManages configuration settings for the Storm CLI.
storm config <subcommand>Subcommands:
get <key>: Retrieves a configuration value.set <key> <value>: Sets a configuration value.list: Lists all configuration settings.
Deploys the application to a specified environment.
storm deploy [options]Options:
--env <environment>: Specify the environment for deployment (e.g., production, staging).--dry-run: Simulate the deployment without actually performing it.
Manages environment variables for the application.
storm env <subcommand> [options]Subcommands:
add <key> <value>: Adds a new environment variable.remove <key>: Removes an environment variable.list: Lists all environment variables.
Manages caching mechanisms used by the application.
storm cache <subcommand>Subcommands:
clear: Clears the application cache.status: Displays the status of the cache.
Updates the Storm CLI to the latest version.
storm update [options]Options:
--force: Force update even if the current version is up-to-date.
Manages plugins for the Storm framework.
storm plugin <subcommand> [options]Subcommands:
install <plugin-name>: Installs a plugin.uninstall <plugin-name>: Uninstalls a plugin.list: Lists all installed plugins.
Runs diagnostics on the project to identify common problems or misconfigurations.
storm doctor [options]Options:
--fix: Automatically attempt to fix detected issues.
Displays logs for the application.
storm logs [options]Options:
--tail: Continuously stream logs.--filter <pattern>: Filter logs based on a specific pattern.
Configuration for the CLI can be managed using the storm config command. This allows you to set and retrieve configuration options specific to your development environment and needs.
Contributions are welcome! Please see our CONTRIBUTING.md for guidelines on how to get started.
Storm CLI is open-source software licensed under the MIT license.