Skip to content

Latest commit

 

History

History

README.md

@elysiumjs/styx

CLI tool for Elysium.js framework.

Installation

bun install @elysiumjs/styx

Usage

The styx command needs to be run inside an Elysium.js project.

To create new items:

bun styx make:command [options]
bun styx make:controller [options]
bun styx make:job [options]
bun styx make:middleware [options]
bun styx make:model [options]
bun styx make:repository [options]
bun styx make:service [options]
bun styx make:validator [options]

To manage migrations:

bun styx migration:generate [options]
bun styx migration:run [options]

To manage modules:

bun styx module:new [options]
bun styx module:rename [options]

To start the Elysium.js project:

bun styx serve

To execute a custom command:

bun styx <command>

To show all available commands:

bun styx list

To get help for a specific command:

bun styx help <command>

Contributing

This project is built primarily to meet requirements for internal projects at Workbud Technologies Inc.

Feel free to open issues for any bugs or questions you may have. Pull requests are also welcome, but they will be reviewed to ensure they align with our internal project's goals and standards.

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for more information.