Skip to content

Commit

Permalink
disabling cli doc auto generation until script is fixed to exclude lo…
Browse files Browse the repository at this point in the history
…cal paths
  • Loading branch information
dhchandw committed Dec 6, 2024
1 parent 4bc1bdb commit f98a511
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ node src-script/generate-template-helper-docs.js
git add docs/api.md
git add docs/helpers.md

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

echo "🚀 > Eslint..."
npx eslint .
Expand Down
6 changes: 3 additions & 3 deletions docs/zap-cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ZAP CLI

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`
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.

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

0 comments on commit f98a511

Please sign in to comment.