CLI
Modules
List, inspect, add, and remove template modules.
Manage project template modules.
Available commands:
| Command | Synonyms | Description |
|---|
list | - | List available and installed modules. |
show | - | Show details for one module. |
add | install | Add a module to the project. |
remove | - | Remove a module from the project. |
project module list [directory] [flags]
| Argument | Required | Default | Description |
|---|
directory | no | . | Project directory. |
| Flag | Synonyms | Type | Default | Description |
|---|
--format | - | string | pretty | Output format. Use tsv for filtering. |
--help | -h | boolean | false | Print help. |
project module list
project module list --format tsv
project module show <module> [directory] [flags]
| Argument | Required | Default | Description |
|---|
module | yes | none | Module name. |
directory | no | . | Project directory. |
| Flag | Synonyms | Type | Default | Description |
|---|
--format | - | string | pretty | Output format. Use tsv for filtering. |
--help | -h | boolean | false | Print help. |
project module show core.repo
project module show core.repo --format tsv
Add a module to a project.
project module add <module> [directory] [flags]
Synonym: project module install <module> [directory] [flags]
| Argument | Required | Default | Description |
|---|
module | yes | none | Module name. |
directory | no | . | Project directory. |
| Flag | Synonyms | Type | Default | Description |
|---|
--dry-run | - | boolean | false | Show the module add plan without writing changes. |
--force | - | boolean | false | Allow module add to overwrite existing project files. |
--format | - | string | pretty | Output format. Use tsv with --dry-run or --yes. |
--yes | -y | boolean | false | Apply without prompting. |
--help | -h | boolean | false | Print help. |
- Prints a plan before writing.
- Prompts before applying unless
--yes is passed.
- Fails on file conflicts unless
--force is passed.
--dry-run never writes files.
project module add core.repo --dry-run
project module add core.repo
project module add core.repo --yes
project module add core.repo --dry-run --format tsv
Remove a module from a project.
project module remove <module> [directory] [flags]
| Argument | Required | Default | Description |
|---|
module | yes | none | Module name. |
directory | no | . | Project directory. |
| Flag | Synonyms | Type | Default | Description |
|---|
--dry-run | - | boolean | false | Show the module remove plan without writing changes. |
--format | - | string | pretty | Output format. Use tsv with --dry-run or --yes. |
--yes | -y | boolean | false | Apply without prompting. |
--help | -h | boolean | false | Print help. |
project module remove core.repo --dry-run
project module remove core.repo --yes
project module remove core.repo --dry-run --format tsv