|
| 1 | +# Solidarity Command Options |
| 2 | +A listing of CLI options can be found by passing the `help` command to the CLI. |
| 3 | + |
| 4 | +``` |
| 5 | + $ solidarity help |
| 6 | +
|
| 7 | +Solidarity |
| 8 | + Commands |
| 9 | +
|
| 10 | + solidarity Check environment against solidarity rules |
| 11 | + create (c) Displays this help |
| 12 | + help (h) Displays this help |
| 13 | + report (r) Report solidarity info about the current machine |
| 14 | + snapshot (s) Take a snapshot of the versions and store in solidarity file |
| 15 | +
|
| 16 | + Flags |
| 17 | +
|
| 18 | + --verbose (-a) Prints all detected info during solidarity check |
| 19 | + --moderate (-m) Prints failures in check or single success message |
| 20 | + --silent (-s) No output, just a return code of success/failure |
| 21 | + --solidarityFile (-f) Use given path to solidarity file for settings |
| 22 | + --module (-m) Search for a solidarity file in the given npm package |
| 23 | + --stack (-t) Use a known technology stack, and not the local file |
| 24 | +
|
| 25 | +Solidarity is open source - https://github.com/infinitered/solidarity |
| 26 | +If you need additional help, join our Slack at http://community.infinite.red |
| 27 | +``` |
| 28 | + |
| 29 | +Here we will go into detail on each option flag. |
| 30 | + |
| 31 | +## verbose (-a) |
| 32 | +Passing `--verbose` or `-a` flags will modify output to be verbose. |
| 33 | + |
| 34 | +## moderate (-m) |
| 35 | +Passing `--moderate` or `-m` flags will modify output to be moderate, meaning only failures exclusive or a single success will be printed. |
| 36 | + |
| 37 | +## silent (-s) |
| 38 | +Passing `--silent` or `-s` flags will modify output to be silent, meaning no output will occur. You'll have to see if the command return is non-zero to see if it failed. |
| 39 | + |
| 40 | +## solidarityFile (-f) |
| 41 | +Passing `--solidarityFile` or `-f` flags will direct the file to use for the solidarity check. |
| 42 | + |
| 43 | +> For example: `solidarity -solidarityFile ./my/special/file.json` will run the designated file instead of looking for a local folder Solidarity file. |
| 44 | +
|
| 45 | +## module (-m) |
| 46 | +Passing `--module` or `-m` flags will modify the designated solidarity file, to run a file found in the given `node_module` stack. |
| 47 | + |
| 48 | +> For example: `solidarity --module smoothReporter` will run the solidarity file in the root of the npm package `smoothReporter` instead of our own. |
| 49 | +
|
| 50 | +## stack (-t) |
| 51 | +Passing `--stack` or `-t` flags will make our stack look to GitHub for a well known tech stack. |
| 52 | + |
| 53 | +> For example: `solidarity --stack react-native` will check our machine if we are ready to run React Native projects, but not a specific React Native project. |
| 54 | +
|
| 55 | +Stacks are community managed and found here: https://github.com/infinitered/solidarity-stacks |
0 commit comments