Skip to main content

shell

This is the configuration interface, deployment interface for the project Webda

http://webda.io

Check our video presentation on Youtube

Install​

npm install @webda/shell --save-dev
# OR
yarn add --dev @webda/shell

Configuration​

You'll get the configuration UI for your project

# To avoid opening browser
webda config --no-open

# Display the configuration for a specific deployment
webda config -d deploymentName

# Export the configuration for a specific deployment to a file
webda config -d deploymentName export.json

Serve the current project​

This will load the Webda framework and run your project with it on port 18080

webda serve

You can serve with a specific deployment configuration by adding the deployment name

webda -d deploymentName serve

Debug the current project​

webda debug

You can debug with a specific deployment configuration by adding the deployment name

webda -d deploymentName debug

It will serve the project on port 18080 and restart the server on any changes made on the folder files If the project has a tsconfig.json, then webda debug will launch the typescript compiler and restart server everytime the compilation process finishes with success.

Deploy​

First you need to create a deployment, from the configuration UI

Then just use the Deploy button on the UI or with webda client :

webda -d deploymentName deploy

Generate Swagger/Postman configuration​

If you use Amazon we expose a way for you to get the Postman configuration of your API using AWS

webda -d deploymentName openapi myOpenApiDocs.json

Only redeploy Lambda code on AWS​

webda -d deploymentName deploy lambda

Requirements​

Node.js >= 16.0.0

Licence​

LGPL 3.0

Enumerations​

Classes​

Interfaces​

Type Aliases​

Variables​