Skip to content
This repository was archived by the owner on Aug 4, 2025. It is now read-only.

Commit af89f7a

Browse files
committed
docs(Commands): add external configuration section
Add detailed documentation for the new external configuration feature, including: - Configuration file location (~/.config/jhlite-cli.yml) - Hidden resources configuration options - Examples of hiding modules by slugs and tags - Effects on list and apply commands
1 parent 6594cac commit af89f7a

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

documentation/Commands.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This document provides an overview of the JHipster Lite CLI commands available i
1212
- [Project Creation Workflow Example](#project-creation-workflow-example)
1313
- [Options and Parameters](#options-and-parameters)
1414
- [Parameters Reuse](#parameter-reuse)
15+
- [External Configuration](#external-configuration)
1516

1617
## Getting Started
1718

@@ -141,3 +142,46 @@ jhlite apply maven-java --package-name com.example.myproject
141142
```
142143

143144
The CLI will automatically reuse the `project-name`, `base-name`, and `node-package-manager` values from your previous command.
145+
146+
## External Configuration
147+
148+
JHipster Lite CLI supports external configuration files to customize its behavior. The CLI automatically looks for a configuration file at:
149+
150+
```
151+
~/.config/jhlite-cli.yml
152+
```
153+
154+
If this file exists, it will be loaded automatically when the CLI starts.
155+
156+
### Configuration Options
157+
158+
#### Hidden Resources
159+
160+
You can hide specific modules from being displayed in the `list` command and prevent them from being applied. This is useful for customizing which modules are available in different environments.
161+
162+
Create a `~/.config/jhlite-cli.yml` file with the following structure:
163+
164+
```yaml
165+
jhlite:
166+
hidden-resources:
167+
slugs:
168+
- gradle-java
169+
- module-slug-to-hide
170+
tags:
171+
- setup
172+
- tag-to-hide
173+
```
174+
175+
**Configuration properties:**
176+
177+
- `slugs`: List of specific module slugs to hide
178+
- `tags`: List of module tags to hide (hides all modules with these tags)
179+
180+
**Effects of hidden resources:**
181+
182+
- Hidden modules will not appear in the output of `jhlite list`
183+
- Hidden modules cannot be applied using `jhlite apply <hidden-module>`
184+
- Attempting to apply a hidden module will result in an "Unmatched arguments" error
185+
186+
**Example:**
187+
If you hide the `gradle-java` module, running `jhlite list` will not show it in the available modules, and running `jhlite apply gradle-java` will fail with an error.

0 commit comments

Comments
 (0)