Godspeed CLI
CLI to create and manage Godspeed projects.
About
Godspeed 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.
How to install
npm install -g @godspeedsystems/godspeed
or
yarn global add @godspeedsystems/godspeed
Once Godspeed CLI is installed, the godspeed command can be called from command line. When called without arguments, it displays its help and command usage.
$ godspeed
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Usage: Godspeed CLI [options] [command]
CLI tool for godspeed framework.
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
create [options] <projectName> create a new godspeed project.
dev run godspeed development server.
clean clean the previous build.
gen-crud-api scans your prisma datasources and generate
CRUD APIs events and workflows
serve build and preview the production build in watch mode.
build build the godspeed project.
preview preview the production build.
devops-plugin manage(add, remove, update) godspeed plugins
for devops.
plugin manage(add, remove, update) eventsource and
datasource plugins for godspeed.
prisma proxy to prisma commands with some add-on
commands to handle prisma datasources.
help [command] display help for command
For detailed documentation visit https://godspeed.systems
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 | add, remove, update | manage devops plugins for godspeed. |
| plugins | add, remove, update | manage eventsource and datasource plugins for godspeed. |
| gen-crud-api | generate CRUD APIs based on prisma schema. | |
| prisma | prepare | generates your prisma client for database and sync the database with the schema |
create
The create command creates project structure for your microservice. When called without arguments, it creates project structure with default examples.
$ godspeed create my-service
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
… waiting Cloning project template.
✔ success Cloning template successful.
… waiting Generating project with default examples.
… waiting Generating project files.
✔ success Successfully generated godspeed project files.
dependencies installed successfully!
Successfully created the project my-service.
Use `godspeed help` command for available commands.
Happy building microservices with Godspeed! 🚀🎉
Options for create command
$ godspeed help create
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Usage: Godspeed CLI create [options] <projectName>
create a new godspeed project.
Arguments:
projectName name of the project.
Options:
--from-template <projectTemplateName> create a project from a template.
--from-example <exampleName> create a project from examples.
-h, --help display help for command
- While using
--from-templateyou have to mention the path of the project folder which you want to clone as template - While using
--from-exampleyou have to mention any name from the available examples. [available names are hello-world, mongo-as-prisma]
Running the service
You can run your Godspeed project using godspeed serve command. This will run your project in auto-watch mode.
godspeed serve
prisma
The prisma command is a proxy to prisma commands with some add-on commands to handle prisma datasources.
$ godspeed prisma [options]
prisma prepare
The godspeed prisma prepare generates your prisma client for database and sync the database with the schema.
$ godspeed prisma prepare
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Environment variables loaded from .env
Prisma schema loaded from src/datasources/mongo.prisma
Environment variables loaded from .env
Prisma schema loaded from src/datasources/mongo.prisma
Datasource "db": MongoDB database "test" at "cluster0.syzyst8.mongodb.net"
✔ Generated Prisma Client (v5.4.2) to ./node_modules/@prisma/client in 114ms
Start using Prisma Client in Node.js (See: https://pris.ly/d/client)
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
or start using Prisma Client at the edge (See: https://pris.ly/d/accelerate)
import { PrismaClient } from '@prisma/client/edge'
const prisma = new PrismaClient()
See other ways of importing Prisma Client: http://pris.ly/d/importing-client
The database is already in sync with the Prisma schema.
✔ Generated Prisma Client (v5.4.2) to ./node_modules/@prisma/client in 115ms
gen-crud-api
The godspeed gen-crud-api command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/mongo.prisma[name of your prisma schema].
$ godspeed gen-crud-api
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
> blog-app@1.0.0 gen-crud-api
> npx @godspeedsystems/api-generator
Select datasource / schema to generate CRUD APIs
(x) mongo.prisma
( ) For all
( ) Cancel
plugin
Godspeed plugins are the way to extend the core Godspeed framework. Currently we support adding eventsource and datasource as plugin.
$ godspeed help plugin
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Usage: Godspeed CLI plugin [options] [command]
manage(add, remove, update) eventsource and datasource plugins for godspeed.
Options:
-h, --help display help for command
Commands:
add [pluginName] Add an eventsource/datasource plugin.
remove [pluginName] Remove an eventsource/datasource plugin.
update Update an eventsource/datasource plugin.
help [command] display help for command
For detailed documentation visit https://godspeed.systems
plugin add
The godspeed plugin add command allows the user to select a plugin from the list of available plugins and add them to the project.
$ godspeed plugin add
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select godspeed plugin to install: (Press <space> to select, <Up and Down> to move rows)
┌──────┬────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐
│ │ Name │ Description │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ❯◯ │ aws-as-datasource │ aws as datasource plugin for Godspeed Framework │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ excel-as-datasource │ excel as datasource plugin for Godspeed Framework │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ mailer-as-datasource │ mailer as datasource plugin for Godspeed Framework │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ kafka-as-datasource-as-eventsource │ kafka as datasource-as-eventsource plugin for Godspeed Framework │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ cron-as-eventsource │ Cron as eventsource plugin for Godspeed Framework │
└──────┴────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘
plugin remove
The godspeed plugin remove command allows the user to select a plugin from the list of available plugins and remove them from the project.
$ godspeed plugin remove
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select godspeed plugin to uninstall: (Press <space> to select, <Up and Down> to move rows)
┌──────┬────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐
│ │ Name │ Description │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ❯◯ │ express-as-http │ Godspeed event source plugin for express as http server │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ prisma-as-datastore │ Prisma as a datasource plugin for Godspeed Framework. │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ axios-as-datasource │ Axios as datasource plugin for Godspeed Framework │
└──────┴────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘
plugin update
The godspeed plugin update command allows the user to select a plugin from the list of available plugins and update them.
$ godspeed plugin update
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select godspeed plugin to update: (Press <space> to select, <Up and Down> to move rows)
┌──────┬────────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐
│ │ Name │ Description │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ❯◯ │ express-as-http │ Godspeed event source plugin for express as http server │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ prisma-as-datastore │ Prisma as a datasource plugin for Godspeed Framework. │
├──────┼────────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ ◯ │ axios-as-datasource │ Axios as datasource plugin for Godspeed Framework │
└──────┴────────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘
devops-plugin
Godspeed devops-plugins are the way to extend the core Godspeed framework. Currently we support adding eventsource and datasource as devops-plugin.
$ godspeed help devops-plugin
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Usage: Godspeed CLI devops-plugin [options] [command]
manages godspeed devops-plugins.
Options:
-h, --help display help for command
Commands:
install install a godspeed devops plugin
list [options] list of available godspeed devops plugins
remove remove a godspeed devops plugin
update update a godspeed devops plugin
k8s installed godspeed devops plugin
help [command] display help for command
For detailed documentation visit https://godspeed.systems
To see help for any installed devops plugin, you can run:
<plugin-name> help
devops-plugin install
The godspeed devops-plugin install command allows the user to select a devops plugin from the list of available plugins and add them to the operating system.
$ godspeed devops-plugin install
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select devops plugin to install. (Use arrow keys)
❯ @godspeedsystems/k8s
(Move up and down to reveal more choices)
devops-plugin remove
The godspeed devops-plugin remove command allows the user to select a devops plugin from the list of installed plugins and remove them from the operating system.
$ godspeed devops-plugin remove
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select a devops plugin to remove. (Use arrow keys)
❯ @godspeedsystems/k8s
(Move up and down to reveal more choices)
devops-plugin update
The godspeed devops-plugin update command allows the user to select a devops plugin from the list of installed plugins and update them.
$ godspeed devops-plugin update
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
? Please select devops plugin to update. (Use arrow keys)
❯ @godspeedsystems/k8s
(Move up and down to reveal more choices)
otel
CLI provides otel command to enable/disable observability in Godspeed.
$ godspeed help otel
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
Usage: Godspeed CLI otel [options] [command]
enable/disable Observability in Godspeed.
Options:
-h, --help display help for command
Commands:
enable enable Observability in project.
disable disable Observability in project.
help [command] display help for command
For detailed documentation visit https://godspeed.systems
otel enable
The godspeed otel enable command allows the user to enable observability in Godspeed to collect traces, metrics and logs.
$ godspeed otel enable
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
otel installed successfully!
Observability has been enabled
The above command performs these two functions:
A. Installs @godspeedsystems/tracing package
This package includes auto-instrumentation of the following plugins to collect traces:
1. http and https requests.
2. Prisma datasource plugin.
B. Sets OTEL_ENABLED env variable to true
By setting OTEL_ENABLED to true, the following actions are performed:
1. Traces: starts the auto-instrumentation of traces present in the @godspeedsystems/tracing package.
2. Metrics: starts exposing application metrics at /metrics endpoint of the service. Currently, the framework exposes HTTP and Prisma datasource metrics.
3. Logs: starts dumping the service logs in OTEL log format in console provided NODE_ENV is not equal to 'dev'
Follow this Github issue to know how auto-instrumentation can be enabled for the other custom eventsource and datasource plugins.
Follow this Github issue to know how prometheus based metrics can be exposed for the other custom eventsource and datasource plugins.
otel disable
The godspeed otel disable command allows the user to disable observability in Godspeed.
$ godspeed otel disable
,_, ╔════════════════════════════════════╗
(o,o) ║ Welcome to Godspeed ║
({___}) ║ World's First Meta Framework ║
" " ╚════════════════════════════════════╝
otel uninstalled successfully!
Observability has been disabled in the project
The above command performs these two functions:
A. Uninstalls @godspeedsystems/tracing package from your service.
B. Sets OTEL_ENABLED env variable to false
Setting OTEL_ENABLED to false stops all the actions performed in otel enable command