docs: mention that debug option is CLI only

semantic-release · Dec 11, 2018 · 649b530 · 649b530
1 parent 862ec4c
commit 649b530
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md
@@ -133,6 +133,8 @@ CLI argument: `--debug`
 
 Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
 
+**Note**: The `debug` is used only supported via CLI argument. To enable debug mode from the [JS API](../developer-guide/js-api.md#javascript-api) use `require('debug').enable('semantic-release:*')`.
+
 ## Git environment variables
 
 | Variable              | Description                                                                                                                                                                                                                    | Default                              |