{"id":27939442,"url":"https://github.com/strmio/storm-cli","last_synced_at":"2025-07-23T15:40:04.638Z","repository":{"id":255421634,"uuid":"847468688","full_name":"strmio/storm-cli","owner":"strmio","description":"CLI tool for Storm applications","archived":false,"fork":false,"pushed_at":"2025-04-20T10:30:06.000Z","size":123,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-13T18:31:36.712Z","etag":null,"topics":["cli","command-line","storm"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/strmio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-25T22:42:12.000Z","updated_at":"2025-04-19T23:21:15.000Z","dependencies_parsed_at":"2024-08-29T22:56:33.332Z","dependency_job_id":"2913a4fb-403e-4421-a9a9-0113199d7e82","html_url":"https://github.com/strmio/storm-cli","commit_stats":null,"previous_names":["adi3g/storm-cli","stormpyio/storm-cli","strmio/storm-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/strmio/storm-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strmio%2Fstorm-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strmio%2Fstorm-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strmio%2Fstorm-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strmio%2Fstorm-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/strmio","download_url":"https://codeload.github.com/strmio/storm-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strmio%2Fstorm-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266679634,"owners_count":23967669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","storm"],"created_at":"2025-05-07T09:42:21.023Z","updated_at":"2025-07-23T15:40:04.608Z","avatar_url":"https://github.com/strmio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Storm CLI\n\nStorm 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.\n\n## Table of Contents\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Commands](#commands)\n  - [new](#new)\n  - [generate (g)](#generate-g)\n  - [serve](#serve)\n  - [build](#build)\n  - [test](#test)\n  - [lint](#lint)\n  - [migrate](#migrate)\n  - [console](#console)\n  - [config](#config)\n  - [deploy](#deploy)\n  - [env](#env)\n  - [cache](#cache)\n  - [update](#update)\n  - [plugin](#plugin)\n  - [doctor](#doctor)\n  - [logs](#logs)\n- [Configuration](#configuration)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nYou can install Storm CLI using pip:\n\n```bash\npip install storm-cli\n```\n\n## Getting Started\n\nTo create a new Storm project, use the `new` command:\n\n```bash\nstorm new my-storm-app\n```\n\nThis command will scaffold a new Storm project in a directory named `my-storm-app` with a basic structure and initial setup.\n\n## Commands\n\n### `new`\n\nScaffolds a new Storm project.\n\n```bash\nstorm new \u003cproject-name\u003e [options]\n```\n\n**Options:**\n- `--skip-install`: Skip installing dependencies.\n- `--template \u003ctemplate-name\u003e`: Use a specific project template.\n\n### `generate` (or `g`)\n\nGenerates a new resource within the project.\n\n```bash\nstorm generate \u003ctype\u003e \u003cname\u003e [options]\n```\n\n**Types:**\n- `module`\n- `controller`\n- `service`\n- `guard`\n- `middleware`\n- `interceptor`\n- `filter`\n- `entity`\n- `resource`\n\n**Options:**\n- `--dry-run`: Show what files would be created without actually creating them.\n- `--flat`: Generate files without a nested folder.\n\n### `serve`\n\nStarts the application server for development.\n\n```bash\nstorm serve [options]\n```\n\n**Options:**\n- `--port \u003cport\u003e`: Specify the port to serve on (default: 3000).\n- `--watch`: Restart the server on file changes.\n- `--debug`: Run in debug mode for additional logging and debugging.\n\n### `build`\n\nBuilds the Storm application for production deployment.\n\n```bash\nstorm build [options]\n```\n\n**Options:**\n- `--prod`: Build in production mode.\n- `--output \u003cdirectory\u003e`: Specify the output directory for the build files.\n\n### `test`\n\nRuns the tests for the Storm application.\n\n```bash\nstorm test [options]\n```\n\n**Options:**\n- `--watch`: Run tests in watch mode.\n- `--coverage`: Generate a code coverage report.\n- `--filter \u003cpattern\u003e`: Run tests that match a specific pattern.\n\n### `lint`\n\nLints the project’s code to enforce coding standards.\n\n```bash\nstorm lint [options]\n```\n\n**Options:**\n- `--fix`: Automatically fix linting errors where possible.\n- `--rules \u003crule-set\u003e`: Use a specific set of linting rules.\n\n### `migrate`\n\nManages database migrations.\n\n```bash\nstorm migrate \u003csubcommand\u003e [options]\n```\n\n**Subcommands:**\n- `run`: Applies pending migrations.\n- `revert`: Reverts the last applied migration.\n- `create \u003cname\u003e`: Creates a new migration file.\n- `status`: Shows the current status of migrations.\n\n### `console`\n\nOpens an interactive REPL session within the context of the application.\n\n```bash\nstorm console\n```\n\n### `config`\n\nManages configuration settings for the Storm CLI.\n\n```bash\nstorm config \u003csubcommand\u003e\n```\n\n**Subcommands:**\n- `get \u003ckey\u003e`: Retrieves a configuration value.\n- `set \u003ckey\u003e \u003cvalue\u003e`: Sets a configuration value.\n- `list`: Lists all configuration settings.\n\n### `deploy`\n\nDeploys the application to a specified environment.\n\n```bash\nstorm deploy [options]\n```\n\n**Options:**\n- `--env \u003cenvironment\u003e`: Specify the environment for deployment (e.g., production, staging).\n- `--dry-run`: Simulate the deployment without actually performing it.\n\n### `env`\n\nManages environment variables for the application.\n\n```bash\nstorm env \u003csubcommand\u003e [options]\n```\n\n**Subcommands:**\n- `add \u003ckey\u003e \u003cvalue\u003e`: Adds a new environment variable.\n- `remove \u003ckey\u003e`: Removes an environment variable.\n- `list`: Lists all environment variables.\n\n### `cache`\n\nManages caching mechanisms used by the application.\n\n```bash\nstorm cache \u003csubcommand\u003e\n```\n\n**Subcommands:**\n- `clear`: Clears the application cache.\n- `status`: Displays the status of the cache.\n\n### `update`\n\nUpdates the Storm CLI to the latest version.\n\n```bash\nstorm update [options]\n```\n\n**Options:**\n- `--force`: Force update even if the current version is up-to-date.\n\n### `plugin`\n\nManages plugins for the Storm framework.\n\n```bash\nstorm plugin \u003csubcommand\u003e [options]\n```\n\n**Subcommands:**\n- `install \u003cplugin-name\u003e`: Installs a plugin.\n- `uninstall \u003cplugin-name\u003e`: Uninstalls a plugin.\n- `list`: Lists all installed plugins.\n\n### `doctor`\n\nRuns diagnostics on the project to identify common problems or misconfigurations.\n\n```bash\nstorm doctor [options]\n```\n\n**Options:**\n- `--fix`: Automatically attempt to fix detected issues.\n\n### `logs`\n\nDisplays logs for the application.\n\n```bash\nstorm logs [options]\n```\n\n**Options:**\n- `--tail`: Continuously stream logs.\n- `--filter \u003cpattern\u003e`: Filter logs based on a specific pattern.\n\n## Configuration\n\nConfiguration 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.\n\n## Contributing\n\nContributions are welcome! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started.\n\n## License\n\nStorm CLI is open-source software licensed under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrmio%2Fstorm-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstrmio%2Fstorm-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrmio%2Fstorm-cli/lists"}