This package is part of the
🔌 Powerlines monorepo. Powerlines is the "any framework" framework that simplifies modern dev tool usage, generates virtual (or actual) code modules, and improves DX across the board.
💻 Visit stormsoftware.com to stay up to date with this developer

[!IMPORTANT]
This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
Powerlines - Command-Line Interface (CLI)
The Powerlines command-line interface application.
Table of Contents
Installing
Using pnpm:
pnpm add @powerlines/cli
Using npm
npm install @powerlines/cli
Using yarn
yarn add @powerlines/cli
Commands
Commands
The following commands are available in the command-line interface application:
Generate Typescript Declaration File
Generate the project's Typescript declaration file.
Usage
The types command can be executed using the following syntax:
$ npx cli types [options]
Options
The following options are available for the types command:
This command does not have any options.
Prepare Artifacts
Generate the project's required build and deployment artifacts.
Usage
The prepare command can be executed using the following syntax:
$ npx cli prepare [options]
Options
The following options are available for the prepare command:
This command does not have any options.
Garbage Collection
Perform garbage collection to clean up unnecessary system files based on the specified options. This can help free up disk space and improve system performance.
Note: The actual types of environment paths available for cleanup may vary based on the project's configuration and the underlying system's operating system.
Usage
The gc command can be executed using the following syntax:
$ npx cli gc [options]
Options
The following options are available for the gc command:
This command does not have any options.
Generate Documentation
Generate documentation for the project's source code.
Usage
The docs command can be executed using the following syntax:
$ npx cli docs [options]
Options
The following options are available for the docs command:
This command does not have any options.
Deploy
Deploys the project and its generated assets/artifacts.
Usage
The deploy command can be executed using the following syntax:
$ npx cli deploy [options]
Options
The following options are available for the deploy command:
This command does not have any options.
Create Project
Create a new Powerlines project.
Usage
The create command can be executed using the following syntax:
$ npx cli create [options]
Options
The following options are available for the create command:
This command does not have any options.
Clean
Cleans the project by removing build artifacts and temporary files.
Usage
The clean command can be executed using the following syntax:
$ npx cli clean [options]
Options
The following options are available for the clean command:
This command does not have any options.
Build
Builds the project for production deployment.
Usage
The build command can be executed using the following syntax:
$ npx cli build [options]
Options
The following options are available for the build command:
This command does not have any options.
Lint Source Code
Lint the project's source code for style and syntax errors.
Usage
The lint command can be executed using the following syntax:
$ npx cli lint [options]
Options
The following options are available for the lint command:
This command does not have any options.
Changelog
Display the Command Line Interface changelog.
Usage
The changelog command can be executed using the following syntax:
$ npx cli changelog [options]
Options
The following options are available for the changelog command:
This command does not have any options.
Upgrade
A command for checking and upgrading the version of the command-line interface application.
Usage
The upgrade command can be executed using the following syntax:
$ npx cli upgrade [options]
Options
The following options are available for the upgrade command:
This command does not have any options.
Help
Display command usage details and other useful information to the user.
Usage
The help command can be executed using the following syntax:
$ npx cli help [options]
Options
The following options are available for the help command:
This command does not have any options.
Configuration
Development
This project is built using Nx. As a result, many of the usual
commands are available to assist in development.
Building
Run nx build cli to build the library.
Running unit tests
Run nx test cli to execute the unit tests via
Jest.
Linting
Run nx lint cli to run
ESLint on the package.
Storm Workspaces
Storm workspaces are built using
Nx, a set of extensible dev tools
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
Building on top of Nx, the Open System provides a set of tools and patterns that
help you scale your monorepo to many teams while keeping the codebase
maintainable.
Roadmap
See the open issues for
a list of proposed features (and known issues).
Support
Reach out to the maintainer at one of the following places:
License
This project is licensed under the Apache License 2.0. Feel free to edit and
distribute this template as you like.
See LICENSE for more information.
Changelog
This project adheres to
Semantic Versioning. Every release, along
with the migration instructions, is documented in the CHANGELOG
file
Contributing
First off, thanks for taking the time to contribute! Contributions are what
makes the open-source community such an amazing place to learn, inspire, and
create. Any contributions you make will benefit everybody else and are greatly
appreciated.
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what
environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Please adhere to this project's code of conduct.
You can use
markdownlint-cli
to check for common markdown style inconsistency.
Contributors
Thanks goes to these wonderful people
(emoji key):
This project follows the
all-contributors
specification. Contributions of any kind welcome!
Fingerprint: 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
Storm Software is an open source software development organization and creator
of Acidic, StormStack and StormCloud.
Our mission is to make software development more accessible. Our ideal future is
one where anyone can create software without years of prior development
experience serving as a barrier to entry. We hope to achieve this via LLMs,
Generative AI, and intuitive, high-level data modeling/programming languages.
Join us on Discord to chat with the team,
receive release notifications, ask questions, and get involved.
If this sounds interesting, and you would like to help us in creating the next
generation of development tools, please reach out on our
website or join our
Slack channel!