|
| 1 | +# Private Reveal Example |
| 2 | + |
| 3 | +Demonstrates how to allow users to reveal any private commands, flags and |
| 4 | +environment variables. |
| 5 | + |
| 6 | +This example was generated with: |
| 7 | + |
| 8 | +```bash |
| 9 | +$ bashly init |
| 10 | +$ bashly add settings |
| 11 | +# ... now edit settings.yml to match the example ... |
| 12 | +# ... now edit src/bashly.yml to match the example ... |
| 13 | +$ bashly generate |
| 14 | +``` |
| 15 | + |
| 16 | +<!-- include: settings.yml --> |
| 17 | + |
| 18 | +----- |
| 19 | + |
| 20 | +## `bashly.yml` |
| 21 | + |
| 22 | +````yaml |
| 23 | +name: cli |
| 24 | +help: Sample application |
| 25 | +version: 0.1.0 |
| 26 | + |
| 27 | +# All elements with `private: true` in this configuration will be hidden |
| 28 | +# unless the environment variable SHOW_PELASE is set (as defined |
| 29 | +# in ../settings.yml) |
| 30 | + |
| 31 | +environment_variables: |
| 32 | +- name: secret |
| 33 | + help: Set secret key |
| 34 | + private: true |
| 35 | + |
| 36 | +flags: |
| 37 | +- long: --debug |
| 38 | + help: Enable debug mode |
| 39 | + private: true |
| 40 | + |
| 41 | +commands: |
| 42 | +- name: admin |
| 43 | + help: Admin operations |
| 44 | + expose: true |
| 45 | + |
| 46 | + commands: |
| 47 | + - name: list |
| 48 | + help: List connected devices |
| 49 | + - name: reboot |
| 50 | + help: Reboot |
| 51 | + private: true |
| 52 | +```` |
| 53 | + |
| 54 | +## `settings.yml` |
| 55 | + |
| 56 | +````yaml |
| 57 | +# When using private commands, flags, or environment variables, you may set |
| 58 | +# this option to a name of an environment variable that, if set, will reveal |
| 59 | +# all the private elements in the usage texts, as if they were public. |
| 60 | +private_reveal_key: SHOW_PLEASE |
| 61 | +```` |
| 62 | + |
| 63 | + |
| 64 | +## Output |
| 65 | + |
| 66 | +### `$ ./cli` |
| 67 | + |
| 68 | +````shell |
| 69 | +cli - Sample application |
| 70 | + |
| 71 | +Usage: |
| 72 | + cli [OPTIONS] COMMAND |
| 73 | + cli [COMMAND] --help | -h |
| 74 | + cli --version | -v |
| 75 | + |
| 76 | +Commands: |
| 77 | + admin Admin operations |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | +```` |
| 82 | + |
| 83 | +### `$ ./cli -h` |
| 84 | + |
| 85 | +````shell |
| 86 | +cli - Sample application |
| 87 | + |
| 88 | +Usage: |
| 89 | + cli [OPTIONS] COMMAND |
| 90 | + cli [COMMAND] --help | -h |
| 91 | + cli --version | -v |
| 92 | + |
| 93 | +Commands: |
| 94 | + admin Admin operations |
| 95 | + admin list List connected devices |
| 96 | + |
| 97 | +Global Options: |
| 98 | + --help, -h |
| 99 | + Show this help |
| 100 | + |
| 101 | + --version, -v |
| 102 | + Show version number |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +```` |
| 107 | + |
| 108 | +### `$ ./cli admin -h` |
| 109 | + |
| 110 | +````shell |
| 111 | +cli admin - Admin operations |
| 112 | + |
| 113 | +Usage: |
| 114 | + cli admin COMMAND |
| 115 | + cli admin [COMMAND] --help | -h |
| 116 | + |
| 117 | +Commands: |
| 118 | + list List connected devices |
| 119 | + |
| 120 | +Options: |
| 121 | + --help, -h |
| 122 | + Show this help |
| 123 | + |
| 124 | + |
| 125 | + |
| 126 | +```` |
| 127 | + |
| 128 | +### `$ export SHOW_PLEASE=1` |
| 129 | + |
| 130 | +````shell |
| 131 | + |
| 132 | + |
| 133 | +```` |
| 134 | + |
| 135 | +### `$ ./cli -h` |
| 136 | + |
| 137 | +````shell |
| 138 | +cli - Sample application |
| 139 | + |
| 140 | +Usage: |
| 141 | + cli [OPTIONS] COMMAND |
| 142 | + cli [COMMAND] --help | -h |
| 143 | + cli --version | -v |
| 144 | + |
| 145 | +Commands: |
| 146 | + admin Admin operations |
| 147 | + admin list List connected devices |
| 148 | + |
| 149 | +Global Options: |
| 150 | + --help, -h |
| 151 | + Show this help |
| 152 | + |
| 153 | + --version, -v |
| 154 | + Show version number |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | +```` |
| 159 | + |
| 160 | +### `$ ./cli admin -h` |
| 161 | + |
| 162 | +````shell |
| 163 | +cli admin - Admin operations |
| 164 | + |
| 165 | +Usage: |
| 166 | + cli admin COMMAND |
| 167 | + cli admin [COMMAND] --help | -h |
| 168 | + |
| 169 | +Commands: |
| 170 | + list List connected devices |
| 171 | + |
| 172 | +Options: |
| 173 | + --help, -h |
| 174 | + Show this help |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | +```` |
| 179 | + |
| 180 | + |
| 181 | + |
0 commit comments