https://github.com/godspeedsystems/godspeed-cli

Godspeed Framework CLI
https://github.com/godspeedsystems/godspeed-cli

godspeed meta-framework

Last synced: 13 days ago
JSON representation

Godspeed Framework CLI

• Host: GitHub
• URL: https://github.com/godspeedsystems/godspeed-cli
• Owner: godspeedsystems
• License: other
• Created: 2022-06-02T06:48:07.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-06T05:14:47.000Z (about 1 month ago)
• Last Synced: 2025-03-06T05:30:58.202Z (about 1 month ago)
• Topics: godspeed, meta-framework
• Language: TypeScript
• Homepage: https://godspeed.systems
• Size: 893 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - godspeedsystems/godspeed-cli - Godspeed Framework CLI (TypeScript)

README

        


    

        

    

    
Godspeed CLI



  The official Command Line Interface of Godspeed Framework






  


[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](https://github.com/godspeedsystems/gs-node-service)

 [![Discord](https://img.shields.io/badge/chat-discord-brightgreen.svg?logo=discord&style=flat)](https://discord.com/invite/MKjv3KdD7X)

 [![Website](https://img.shields.io/website?url=https%3A%2F%2Fgodspeed.systems%2F)](https://godspeed.systems/)

  

  




# Godspeed CLI

CLI to create and manage [Godspeed](https://github.com/godspeedsystems/gs-node-service) projects.

# About

[Godspeed CLI](https://godspeed.systems/docs/microservices-framework/CLI) is the primary way to interact with your Godspeed project from the command line. It provides a bunch of useful functionalities during the project development lifecycle.

## Installation:

Getting started is a breeze! Install Godspeed CLI globally using either npm or yarn:

```bash

npm install -g @godspeedsystems/godspeed

```

or

```bash

yarn global add @godspeedsystems/godspeed

```

## Basic Usage:

Once installed, run godspeed from your terminal to see the available commands and usage information. The CLI provides detailed help messages for each command, guiding you through its functionalities and options.

## Supported Commands & Arguments

  | Command               |     Options       | Description                                                                 |

  |-----------------------|-------------------|-----------------------------------------------------------------------------|

  | create   | --from-template, --from-example| create a new godspeed project.                                 |

  | dev                   |                   | start the dev server.                                                       |

  | clean                 |                   | clean the previous build.                                                   |

  | build                 |                   | build the godspeed project.                                                 |

  | devops-plugins                 |                   | manage devops plugins for godspeed.                                                 |

  | plugins                 |                   | manage eventsource and datasource plugins for godspeed.                                                 |

  | gen-crud-api          |                   | scans your prisma datasources and generate CRUD APIs events and workflows           |

  | gen-graphql-schema          |                   | scans your graphql events and generate graphql schema .        |

## 📖 Documentation 

For a comprehensive understanding of Godspeed CLI and its advanced features, explore the detailed documentation [here](https://godspeed.systems/docs/microservices-framework/guide/get-started).

## Show Your Love ❤️ & Support 🙏

If you find the Godspeed Node.js Service helpful or interesting, we would greatly appreciate your support by following, starring, and subscribing.



    

    Follow us for updates and news.





    

    Star our repositories to show your support.





    

    Subscribe to our channel for tutorials and demos.



## Ask & Answer Questions

Got questions or need help with Godspeed? Join our [Discord community](https://discord.com/invite/E3WU9dT7UQ). You can ask questions, share knowledge, and assist others.