MetaCall Faas Deploy

Tool for deploying into MetaCall FaaS platform.

Table of Contents

• About
  • How to install
  • Configuration
  • Token
• Supported arguments and commands
• Exit codes and their meanings
• Contribute
• License

About

MetaCall Deploy provides the CLI to deploy projects on MetaCall FaaS platform. You can deploy your serverless functions, services and static files within your terminal without interacting with Dashboard.

How to install

npm i -g @metacall/deploy

If you install MetaCall, it comes with the same CLI together and it can be run with:

metacall deploy

Instead of metacall-deploy as provided by NPM.

Check Installation

metacall-deploy --help

Configuration

The configuration is stored in: - Unix: $HOME/.metacall/deploy/config.ini - Windows: %APPDATA%\metacall\deploy\config.ini

Token

The token is stored in the configuration and can be overwritten at any time with METACALL_API_KEY environment variable.

Supported arguments and commands

The metacall-deploy offers many commands for a variety of typical operations.

metacall-deploy --[args=value]

CLI Args	Description
--help	Prints a user manual to assist you in using the cli.
--version	Prints current version of the cli.
--workdir	Accepts relative path to application directory, Defaults to cwd
--addrepo	Accepts url of repository to deploy
--dev	Accepts boolean value: run in dev mode (deploy to local metacall/faas)
--projectName	Accepts a string indicating the name of your project
--email	Accepts email id for authentication
--password	Accepts password for authentication
--token	Accepts token for authentication, either pass email & password or token.
--force	Accepts boolean value: it deletes the deployment present on an existing plan and deploys again
--plan	Accepts type of plan: "Essential", "Standard", "Premium"
--inspect	Accepts format of output : "Table", "Raw", "OpenAPIv3" and Lists out all the deployments with specifications.
--delete	Accepts boolean value: it provides you all the available deployment options to delete
--confDir	Accepts relative path for changing default config directory
--serverUrl	Accepts URL of the MetaCall FaaS base server to override default endpoint
--logout	Accepts boolean value: use it in order to expire your current session.
--listPlans	Accepts boolean value: list all the plans that are offered in your account using it.
--env	Accepts environment variable as KEY=VALUE (can be used multiple times)
--envFile	Accepts path to .env file (can be used multiple times)
--ignore	Accepts pattern to ignore files (can be used multiple times)
--quiet	Accepts boolean value: suppresses non-essential output
--verbose	Accepts boolean value: shows detailed output for debugging
--json	Accepts boolean value: outputs CLI results in JSON format (useful for scripting)
--dryRun	Accepts boolean value: shows what would be deployed without actually deploying
--logs	Print the logs of a deployment.

Ignore Files

If you don't want to deploy node modules or any other file, simply put it inside the .gitignore file as we use for ignoring files.

Exit codes and their meanings

Exit Code	Description
0	Success
1	NotDirectoryRootPath
2	EmptyRootPath
3	NotFoundRootPath
4	AccountDisabled

New to MetaCall? Create account and buy a plan

Go to https://dashboard.metacall.io, signin and buy a plan. Learn more...

Contribute

You Can Directly Start Contributing to this deployer in Cloud with ready to run, build & test the project.

To use it on your forked repo, edit the 'Open in Gitpod' button url to https://gitpod.io/#https://github.com/<my-github-username>/deploy

License

This project is currently licensed under the Apache License version 2.0.