https://github.com/metacall/deploy
Tool for deploying into MetaCall FaaS platform.
https://github.com/metacall/deploy
deployer faas
Last synced: 7 months ago
JSON representation
Tool for deploying into MetaCall FaaS platform.
- Host: GitHub
- URL: https://github.com/metacall/deploy
- Owner: metacall
- License: apache-2.0
- Created: 2019-06-12T10:04:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T19:10:12.000Z (10 months ago)
- Last Synced: 2025-06-03T23:26:03.087Z (7 months ago)
- Topics: deployer, faas
- Language: TypeScript
- Homepage: https://dashboard.metacall.io
- Size: 848 KB
- Stars: 25
- Watchers: 7
- Forks: 41
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MetaCall Faas Deploy
Tool for deploying into MetaCall FaaS platform.
[](https://www.npmjs.com/package/@metacall/deploy)
[](https://github.com/metacall/deploy/actions)
[](https://packagephobia.com/result?p=@metacall/deploy)
[](https://discord.com/channels/781987805974757426/)
## Table of Contents
- [About](#about)
- [How to install](#how-to-install)
- [Configuration](#Configuration)
- [Token](#Token)
- [Supported arguments and commands](#supported-arguments-and-commands)
- [Exit codes and their meanings](#exit-codes-and-their-meanings)
- [Contribute](#Contribute)
- [License](#License)
## About
metacall-deploy provides the interface of options to deploy functions on Metacall FaaS platform. You can deploy your serverless functions within a few clicks without interacting with [Dashboard](https://dashboard.metacall.io/)
## How to install
```bash
npm i -g @metacall/deploy
```
## Check installation
```bash
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.
```bash
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 |
| `--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 |
| `--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. |
## 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...](https://metacall.io/doc.html#/faas/subs-plans)
## Contribute
> You Can Directly Start Contributing to this deployer in Cloud with ready to run, build & test the project.
[](https://gitpod.io/#https://github.com/metacall/deploy)
To use it on your forked repo, edit the 'Open in Gitpod' button url to `https://gitpod.io/#https://github.com//deploy`
## License
This project is currently licensed under the [Apache License version 2.0](LICENSE).