diff --git a/README.md b/README.md index 2a9bff66de2..133b483a0df 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,7 @@ Manage netlify functions | [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | | [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | | [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| [`functions:list`](/docs/commands/functions.md#functionslist) | List functions that exist locally | ### [init](/docs/commands/init.md) diff --git a/docs/README.md b/docs/README.md index 4dc9ba7b88a..8ef06f249b6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -91,6 +91,7 @@ Manage netlify functions | [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | | [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | | [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| [`functions:list`](/docs/commands/functions.md#functionslist) | List functions that exist locally | ### [init](/docs/commands/init.md) diff --git a/docs/commands/functions.md b/docs/commands/functions.md index b0e44aea2a8..ba7e34b2594 100644 --- a/docs/commands/functions.md +++ b/docs/commands/functions.md @@ -21,6 +21,7 @@ netlify functions | [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | | [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | | [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| [`functions:list`](/docs/commands/functions.md#functionslist) | List functions that exist locally | **Examples** @@ -121,6 +122,31 @@ $ netlify functions:invoke myfunction --querystring "foo=1 $ netlify functions:invoke myfunction --payload "./pathTo.json" ``` +--- +## `functions:list` + +List functions that exist locally + +Helpful for making sure that you have formatted your functions correctly + +NOT the same as listing the functions that have been deployed. For that info you need to go to your Netlify deploy log. + + +**Usage** + +```bash +netlify functions:list +``` + +**Flags** + +- `name` (*string*) - name to print +- `functions` (*string*) - Specify a functions folder to serve +- `json` (*boolean*) - Output function data as JSON +- `debug` (*boolean*) - Print debugging information +- `httpProxy` (*string*) - Proxy server address to route requests through. +- `httpProxyCertificateFilename` (*string*) - Certificate file to use when connecting using a proxy server + --- diff --git a/docs/commands/index.md b/docs/commands/index.md index 0c5426604d2..2d0bfd9cee1 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -77,6 +77,7 @@ Manage netlify functions | [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | | [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | | [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| [`functions:list`](/docs/commands/functions.md#functionslist) | List functions that exist locally | ### [init](/docs/commands/init.md) diff --git a/src/commands/functions/list.js b/src/commands/functions/list.js index 3ee2910f29c..3c149bad416 100644 --- a/src/commands/functions/list.js +++ b/src/commands/functions/list.js @@ -109,7 +109,4 @@ FunctionsListCommand.flags = { ...FunctionsListCommand.flags, } -// TODO make visible once implementation complete -FunctionsListCommand.hidden = true - module.exports = FunctionsListCommand