Skip to content

Commit 460bbd0

Browse files
authored
disabling cli doc auto generation until script is fixed to exclude local paths (#1493)
1 parent 4bc1bdb commit 460bbd0

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

.husky/pre-commit

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ node src-script/generate-template-helper-docs.js
1010
git add docs/api.md
1111
git add docs/helpers.md
1212

13-
echo "🚀 > CLI doc regen.."
14-
node src-script/generate-cli-documentation
15-
git add docs/zap-cli.md
13+
# Disabling until script is fixed to exclude local paths from documentation
14+
# echo "🚀 > CLI doc regen.."
15+
# node src-script/generate-cli-documentation
16+
# git add docs/zap-cli.md
1617

1718
echo "🚀 > Eslint..."
1819
npx eslint .

docs/zap-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ZAP CLI
2-
2+
33
The`zap-cli`is a command-line interface for key ZAP functionalities, enabling users to generate and manage ZCL artifacts, launch server instances, and more. `zap-cli`
44
is ideal for those who prefer the command line, need a lightweight alternative to the full UI or need to automate certain ZAP-related tasks.
55

@@ -25,7 +25,7 @@ Options:
2525
-p, --httpPort Port used for the HTTP server [number] [default: 9070]
2626
--studioHttpPort Port used for integration with Silicon Labs Simplicity Studio's internal HTTP server [number] [default: -1]
2727
-i, --zapFile, --zap, --in input .zap file to read in. You can also specify them without an option, directly. [string] [default: null]
28-
-z, --zclProperties, --zcl zcl.properties file to read in. [array] [default: "/Users/dhchandw/tools/zap/zcl-builtin/silabs/zcl.json"]
28+
-z, --zclProperties, --zcl zcl.properties file to read in. [array] [default: "/path/to/zap/zcl-builtin/silabs/zcl.json"]
2929
--sdk sdk.json file to read, for operations that act on whole SDK [string] [default: null]
3030
-g, --generationTemplate, --gen generation template metafile (gen-template.json) to read in. [array] [default: null]
3131
--uiMode, --ui Mode of the UI to begin in. Options are: ZIGBEE [string] [default: "zigbee"]
@@ -70,4 +70,4 @@ Environment variables:
7070
7171
For more information, see https://github.com/project-chip/zap/
7272
73-
```
73+
```

0 commit comments

Comments
 (0)