|
| 1 | +# Command Reference |
| 2 | + |
| 3 | +This document provides detailed information about all available commands in the Helm Values Manager plugin. |
| 4 | + |
| 5 | +## Available Commands |
| 6 | +- [`init`](#init) - Initialize a new values manager configuration. |
| 7 | +- [`add-value-config`](#add-value-config) - Add a new value configuration with metadata. |
| 8 | +- [`add-deployment`](#add-deployment) - Add a new deployment configuration. |
| 9 | +- [`set-value`](#set-value) - Set a value for a specific path and deployment. |
| 10 | +- [`generate`](#generate) - Generate a values file for a specific deployment. |
| 11 | + |
| 12 | +## Command Details |
| 13 | + |
| 14 | +### `init` |
| 15 | + |
| 16 | +Initialize a new values manager configuration. |
| 17 | + |
| 18 | +**Usage:** |
| 19 | +```bash |
| 20 | +helm values-manager init [options] |
| 21 | +``` |
| 22 | + |
| 23 | +**Options:** |
| 24 | +- `--release, -r`: Name of the Helm release |
| 25 | + |
| 26 | +### `add-value-config` |
| 27 | + |
| 28 | +Add a new value configuration with metadata. |
| 29 | + |
| 30 | +**Usage:** |
| 31 | +```bash |
| 32 | +helm values-manager add-value-config [options] |
| 33 | +``` |
| 34 | + |
| 35 | +**Options:** |
| 36 | +- `--path, -p`: Configuration path (e.g., 'app.replicas') |
| 37 | +- `--description, -d`: Description of what this configuration does (default: empty string) |
| 38 | +- `--required, -r`: Whether this configuration is required (default: False) |
| 39 | + |
| 40 | +### `add-deployment` |
| 41 | + |
| 42 | +Add a new deployment configuration. |
| 43 | + |
| 44 | +**Usage:** |
| 45 | +```bash |
| 46 | +helm values-manager add-deployment [options] |
| 47 | +``` |
| 48 | + |
| 49 | +**Arguments:** |
| 50 | +- `name`: Deployment name (e.g., 'dev', 'prod') |
| 51 | + |
| 52 | +### `set-value` |
| 53 | + |
| 54 | +Set a value for a specific path and deployment. |
| 55 | + |
| 56 | +**Usage:** |
| 57 | +```bash |
| 58 | +helm values-manager set-value [options] |
| 59 | +``` |
| 60 | + |
| 61 | +**Options:** |
| 62 | +- `--path, -p`: Configuration path (e.g., 'app.replicas') |
| 63 | +- `--deployment, -d`: Deployment to set the value for (e.g., 'dev', 'prod') |
| 64 | +- `--value, -v`: Value to set |
| 65 | + |
| 66 | +### `generate` |
| 67 | + |
| 68 | +Generate a values file for a specific deployment. |
| 69 | + |
| 70 | +**Usage:** |
| 71 | +```bash |
| 72 | +helm values-manager generate [options] |
| 73 | +``` |
| 74 | + |
| 75 | +**Options:** |
| 76 | +- `--deployment, -d`: Deployment to generate values for (e.g., 'dev', 'prod') |
| 77 | +- `--output, -o`: Directory to output the values file to (default: current directory) (default: .) |
| 78 | + |
| 79 | +## Using Help |
| 80 | + |
| 81 | +Each command supports the `--help` flag for detailed information: |
| 82 | + |
| 83 | +```bash |
| 84 | +helm values-manager --help |
| 85 | +helm values-manager <command> --help |
| 86 | +``` |
0 commit comments