VTEX CLI Plugin Functions

Test StoreFramework JAMStack serverless functions locally.

Developing

The Gatsby store should have a directory functions containing serverless functions. You can use this project as an example: vtex-site/storefaas.store.

Please refer to the this Notion page for more information.

• VTEX CLI Plugin Functions
• Usage
• Commands

Usage

$ npm install -g @vtex/cli-plugin-functions
$ vtex COMMAND
running command...
$ vtex (-v|--version|version)
@vtex/cli-plugin-functions/1.1.0 darwin-x64 node-v15.6.0
$ vtex --help [COMMAND]
USAGE
  $ vtex COMMAND
...

Commands

• vtex sfj
• vtex sfj:start

vtex sfj

StoreFramework serverless functions

USAGE
  $ vtex sfj

EXAMPLE
  $ vtex-test sfj start

See code: build/commands/sfj/index.ts

vtex sfj:start

run a local server to develop with serverless functions

USAGE
  $ vtex sfj:start

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

EXAMPLE
  $ vtex functions

See code: build/commands/sfj/start.ts