1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
|
<!--
This document is automatically generated via the `rake doc:build` task.
Please DO NOT edit this document manually, as your changes will be lost.
Formatting changes should be made to the template: /rake/templates/optionsref.erb
-->
# Command line options reference
## Usage
```
Usage: octocatalog-diff [command line options]
-n HOSTNAME1[,HOSTNAME2[,...]], Use PuppetDB facts from last run of a hostname or a comma separated list of multiple hostnames
--hostname
--basedir DIRNAME Use an alternate base directory (git checkout of puppet repository)
-f, --from FROM_BRANCH Branch you are coming from
-t, --to TO_BRANCH Branch you are going to
--from-catalog FILENAME Use a pre-compiled catalog 'from'
--to-catalog FILENAME Use a pre-compiled catalog 'to'
--bootstrap-script FILENAME Bootstrap script relative to checkout directory
--bootstrap-current Run bootstrap script for the current directory too
--debug-bootstrap Print debugging output for bootstrap script
--bootstrap-environment "key1=val1,key2=val2,..."
Bootstrap script environment variables in key=value format
--bootstrapped-from-dir DIRNAME
Use a pre-bootstrapped 'from' directory
--bootstrapped-to-dir DIRNAME
Use a pre-bootstrapped 'to' directory
--bootstrap-then-exit Bootstrap from-dir and/or to-dir and then exit
--[no-]color Enable/disable colors in output
-o, --output-file FILENAME Output results into FILENAME
--output-format FORMAT Output format: text,json,legacy_json
-d, --[no-]debug Print debugging messages to STDERR
-q, --[no-]quiet Quiet (no status messages except errors)
--ignore "Type1[Title1],Type2[Title2],..."
More resources to ignore in format type[title]
--[no-]include-tags Include changes to tags in the diff output
--fact-file STRING Override fact globally
--to-fact-file STRING Override fact for the to branch
--from-fact-file STRING Override fact for the from branch
--[no-]puppetdb-package-inventory
Include Puppet Enterprise package inventory data, if found
--save-catalog STRING Save intermediate catalogs into files globally
--to-save-catalog STRING Save intermediate catalogs into files for the to branch
--from-save-catalog STRING Save intermediate catalogs into files for the from branch
--cached-master-dir PATH Cache bootstrapped origin/master at this path
--master-cache-branch BRANCH Branch to cache
--safe-to-delete-cached-master-dir PATH
OK to delete cached master directory at this path
--hiera-config STRING Full or relative path to global Hiera configuration file globally
--to-hiera-config STRING Full or relative path to global Hiera configuration file for the to branch
--from-hiera-config STRING Full or relative path to global Hiera configuration file for the from branch
--no-hiera-config Disable hiera config file installation
--hiera-path STRING Path to hiera data directory, relative to top directory of repository globally
--to-hiera-path STRING Path to hiera data directory, relative to top directory of repository for the to branch
--from-hiera-path STRING Path to hiera data directory, relative to top directory of repository for the from branch
--no-hiera-path Do not use any default hiera path settings
--hiera-path-strip STRING Path prefix to strip when munging hiera.yaml globally
--to-hiera-path-strip STRING Path prefix to strip when munging hiera.yaml for the to branch
--from-hiera-path-strip STRING
Path prefix to strip when munging hiera.yaml for the from branch
--no-hiera-path-strip Do not use any default hiera path strip settings
--ignore-attr "attr1,attr2,..."
Attributes to ignore
--filters FILTER1[,FILTER2[,...]]
Filters to apply
--[no-]display-source Show source file and line for each difference
--[no-]validate-references "before,require,subscribe,notify"
References to validate
--[no-]compare-file-text Compare text, not source location, of file resources
--[no-]storeconfigs Enable integration with puppetdb for collected resources
--retry-failed-catalog N Retry building a failed catalog N times
--no-enc Disable ENC
--enc PATH Path to ENC script, relative to checkout directory or absolute
--from-enc PATH Path to ENC script (for the from catalog only)
--to-enc PATH Path to ENC script (for the to catalog only)
--[no-]display-detail-add Display parameters and other details for added resources
--[no-]use-lcs Use the LCS algorithm to determine differences in arrays
--[no-]truncate-details Truncate details with --display-detail-add
--no-header Do not print a header
--default-header Print default header with output
--header STRING Specify header for output
--parser PARSER_NAME Specify parser (default, future)
--parser-from PARSER_NAME Specify parser (default, future)
--parser-to PARSER_NAME Specify parser (default, future)
--[no-]display-datatype-changes
Display changes in data type even when strings match
--[no-]catalog-only Only compile the catalog for the "to" branch but do not diff
--[no-]from-puppetdb Pull "from" catalog from PuppetDB instead of compiling
--[no-]parallel Enable or disable parallel processing
--puppet-binary STRING Full path to puppet binary globally
--to-puppet-binary STRING Full path to puppet binary for the to branch
--from-puppet-binary STRING Full path to puppet binary for the from branch
--puppet-master-token-file STRING
File containing PE RBAC token to authenticate to the Puppetserver API v4 globally
--to-puppet-master-token-file STRING
File containing PE RBAC token to authenticate to the Puppetserver API v4 for the to branch
--from-puppet-master-token-file STRING
File containing PE RBAC token to authenticate to the Puppetserver API v4 for the from branch
--facts-terminus STRING Facts terminus: one of yaml, facter
--puppet-master-token STRING PE RBAC token to authenticate to the Puppetserver API v4 globally
--to-puppet-master-token STRING
PE RBAC token to authenticate to the Puppetserver API v4 for the to branch
--from-puppet-master-token STRING
PE RBAC token to authenticate to the Puppetserver API v4 for the from branch
--puppetdb-token TOKEN Token to access the PuppetDB API
--puppetdb-token-file PATH Path containing token for PuppetDB API, relative or absolute
--puppetdb-url URL PuppetDB base URL
--puppetdb-ssl-ca FILENAME CA certificate that signed the PuppetDB certificate
--puppetdb-ssl-client-cert FILENAME
SSL client certificate to connect to PuppetDB
--puppetdb-ssl-client-key FILENAME
SSL client key to connect to PuppetDB
--puppetdb-ssl-client-password PASSWORD
Password for SSL client key to connect to PuppetDB
--puppetdb-ssl-client-password-file FILENAME
Read password for SSL client key from a file
--puppetdb-api-version N Version of PuppetDB API (3 or 4)
--fact-override STRING1[,STRING2[,...]]
Override fact globally
--to-fact-override STRING1[,STRING2[,...]]
Override fact for the to branch
--from-fact-override STRING1[,STRING2[,...]]
Override fact for the from branch
--puppet-master STRING Hostname or Hostname:PortNumber for Puppet Master globally
--to-puppet-master STRING Hostname or Hostname:PortNumber for Puppet Master for the to branch
--from-puppet-master STRING Hostname or Hostname:PortNumber for Puppet Master for the from branch
--puppet-master-api-version STRING
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) globally
--to-puppet-master-api-version STRING
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) for the to branch
--from-puppet-master-api-version STRING
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) for the from branch
--[no-]puppet-master-update-catalog
Update catalog in PuppetDB when using Puppetmaster API version 4 globally
--[no-]to-puppet-master-update-catalog
Update catalog in PuppetDB when using Puppetmaster API version 4 for the to branch
--[no-]from-puppet-master-update-catalog
Update catalog in PuppetDB when using Puppetmaster API version 4 for the from branch
--[no-]puppet-master-update-facts
Update facts in PuppetDB when using Puppetmaster API version 4 globally
--[no-]to-puppet-master-update-facts
Update facts in PuppetDB when using Puppetmaster API version 4 for the to branch
--[no-]from-puppet-master-update-facts
Update facts in PuppetDB when using Puppetmaster API version 4 for the from branch
--puppet-master-ssl-ca STRING
Full path to CA certificate that signed the Puppet Master certificate globally
--to-puppet-master-ssl-ca STRING
Full path to CA certificate that signed the Puppet Master certificate for the to branch
--from-puppet-master-ssl-ca STRING
Full path to CA certificate that signed the Puppet Master certificate for the from branch
--puppet-master-ssl-client-cert STRING
Full path to certificate file for SSL client auth to Puppet Master globally
--to-puppet-master-ssl-client-cert STRING
Full path to certificate file for SSL client auth to Puppet Master for the to branch
--from-puppet-master-ssl-client-cert STRING
Full path to certificate file for SSL client auth to Puppet Master for the from branch
--puppet-master-ssl-client-key STRING
Full path to key file for SSL client auth to Puppet Master globally
--to-puppet-master-ssl-client-key STRING
Full path to key file for SSL client auth to Puppet Master for the to branch
--from-puppet-master-ssl-client-key STRING
Full path to key file for SSL client auth to Puppet Master for the from branch
--enc-override STRING1[,STRING2[,...]]
Override parameter from ENC globally
--to-enc-override STRING1[,STRING2[,...]]
Override parameter from ENC for the to branch
--from-enc-override STRING1[,STRING2[,...]]
Override parameter from ENC for the from branch
--puppet-master-timeout STRING
Puppet Master catalog retrieval timeout in seconds globally
--to-puppet-master-timeout STRING
Puppet Master catalog retrieval timeout in seconds for the to branch
--from-puppet-master-timeout STRING
Puppet Master catalog retrieval timeout in seconds for the from branch
--pe-enc-url URL Base URL for Puppet Enterprise ENC endpoint
--pe-enc-token TOKEN Token to access the Puppet Enterprise ENC API
--pe-enc-token-file PATH Path containing token for PE node classifier, relative or absolute
--pe-enc-ssl-ca FILENAME CA certificate that signed the ENC API certificate
--pe-enc-ssl-client-cert FILENAME
SSL client certificate to connect to PE ENC
--pe-enc-ssl-client-key FILENAME
SSL client key to connect to PE ENC
--override-script-path DIRNAME
Directory with scripts to override built-ins
--no-ignore-tags Disable ignoring based on tags
--ignore-tags STRING1[,STRING2[,...]]
Specify tags to ignore
--compare-file-text-ignore-tags STRING1[,STRING2[,...]]
Tags that exclude a file resource from text comparison
--[no-]preserve-environments Enable or disable environment preservation
--environment STRING Environment for catalog compilation globally
--to-environment STRING Environment for catalog compilation for the to branch
--from-environment STRING Environment for catalog compilation for the from branch
--create-symlinks STRING1[,STRING2[,...]]
Symlinks to create globally
--to-create-symlinks STRING1[,STRING2[,...]]
Symlinks to create for the to branch
--from-create-symlinks STRING1[,STRING2[,...]]
Symlinks to create for the from branch
--command-line STRING1[,STRING2[,...]]
Command line arguments globally
--to-command-line STRING1[,STRING2[,...]]
Command line arguments for the to branch
--from-command-line STRING1[,STRING2[,...]]
Command line arguments for the from branch
--pass-env-vars VAR1[,VAR2[,...]]
Environment variables to pass
--[no-]suppress-absent-file-details
Suppress certain attributes of absent files
```
## Detailed options description
<table>
<tr>
<th>Option</th>
<th>Description</th>
<th>Extended Description</th>
</tr>
<tr>
<td valign=top>
<pre><code>--basedir DIRNAME</code></pre>
</td>
<td valign=top>
Use an alternate base directory (git checkout of puppet repository)
</td>
<td valign=top>
Option to set the base checkout directory of puppet repository (<a href="../lib/octocatalog-diff/cli/options/basedir.rb">basedir.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrap-current </code></pre>
</td>
<td valign=top>
Run bootstrap script for the current directory too
</td>
<td valign=top>
Option to bootstrap the current directory (by default, the bootstrap script is NOT
run when the catalog builds in the current directory). (<a href="../lib/octocatalog-diff/cli/options/bootstrap_current.rb">bootstrap_current.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrap-environment "key1=val1,key2=val2,..."</code></pre>
</td>
<td valign=top>
Bootstrap script environment variables in key=value format
</td>
<td valign=top>
Allow the bootstrap environment to be set up via the command line. (<a href="../lib/octocatalog-diff/cli/options/bootstrap_environment.rb">bootstrap_environment.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrap-script FILENAME</code></pre>
</td>
<td valign=top>
Bootstrap script relative to checkout directory
</td>
<td valign=top>
Allow specification of a bootstrap script. This runs after checking out the directory, and before running
puppet there. Good for running librarian to install modules, and anything else site-specific that needs
to be done. (<a href="../lib/octocatalog-diff/cli/options/bootstrap_script.rb">bootstrap_script.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrap-then-exit </code></pre>
</td>
<td valign=top>
Bootstrap from-dir and/or to-dir and then exit
</td>
<td valign=top>
Option to bootstrap directories and then exit (<a href="../lib/octocatalog-diff/cli/options/bootstrap_then_exit.rb">bootstrap_then_exit.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrapped-from-dir DIRNAME</code></pre>
</td>
<td valign=top>
Use a pre-bootstrapped 'from' directory
</td>
<td valign=top>
Allow (or create) directories that are already bootstrapped. Handy to allow "bootstrap once, build many"
to save time when diffing multiple catalogs on this system. (<a href="../lib/octocatalog-diff/cli/options/bootstrapped_dirs.rb">bootstrapped_dirs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--bootstrapped-to-dir DIRNAME</code></pre>
</td>
<td valign=top>
Use a pre-bootstrapped 'to' directory
</td>
<td valign=top>
Allow (or create) directories that are already bootstrapped. Handy to allow "bootstrap once, build many"
to save time when diffing multiple catalogs on this system. (<a href="../lib/octocatalog-diff/cli/options/bootstrapped_dirs.rb">bootstrapped_dirs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--cached-master-dir PATH</code></pre>
</td>
<td valign=top>
Cache bootstrapped origin/master at this path
</td>
<td valign=top>
Cache a bootstrapped checkout of 'master' and use that for time-saving when the SHA
has not changed. (<a href="../lib/octocatalog-diff/cli/options/cached_master_dir.rb">cached_master_dir.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--catalog-only
--no-catalog-only </code></pre>
</td>
<td valign=top>
Only compile the catalog for the "to" branch but do not diff
</td>
<td valign=top>
When set, --catalog-only will only compile the catalog for the 'to' branch, and skip any
diffing activity. The catalog will be printed to STDOUT or written to the output file. (<a href="../lib/octocatalog-diff/cli/options/catalog_only.rb">catalog_only.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--color
--no-color </code></pre>
</td>
<td valign=top>
Enable/disable colors in output
</td>
<td valign=top>
Color printing option (<a href="../lib/octocatalog-diff/cli/options/color.rb">color.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--command-line STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Command line arguments globally
</td>
<td valign=top>
Provide additional command line flags to set when running Puppet to compile catalogs. (<a href="../lib/octocatalog-diff/cli/options/command_line.rb">command_line.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--compare-file-text
--no-compare-file-text </code></pre>
</td>
<td valign=top>
Compare text, not source location, of file resources
</td>
<td valign=top>
When a file is specified with `source => 'puppet:///modules/something/foo.txt'`, remove
the 'source' attribute and populate the 'content' attribute with the text of the file.
This allows for a diff of the content, rather than a diff of the location, which is
what is most often desired. (<a href="../lib/octocatalog-diff/cli/options/compare_file_text.rb">compare_file_text.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--compare-file-text-ignore-tags STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Tags that exclude a file resource from text comparison
</td>
<td valign=top>
When a file is specified with `source => 'puppet:///modules/something/foo.txt'`, remove
the 'source' attribute and populate the 'content' attribute with the text of the file.
This allows for a diff of the content, rather than a diff of the location, which is
what is most often desired. (<a href="../lib/octocatalog-diff/cli/options/compare_file_text.rb">compare_file_text.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--create-symlinks STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Symlinks to create globally
</td>
<td valign=top>
Specify which directories from the base should be symlinked into the temporary compilation
environment. This is useful only in conjunction with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/create_symlinks.rb">create_symlinks.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-d
--debug
--no-debug </code></pre>
</td>
<td valign=top>
Print debugging messages to STDERR
</td>
<td valign=top>
Debugging option (<a href="../lib/octocatalog-diff/cli/options/debug.rb">debug.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--debug-bootstrap </code></pre>
</td>
<td valign=top>
Print debugging output for bootstrap script
</td>
<td valign=top>
Option to print debugging output for the bootstrap script in addition to the normal
debugging output. Note that `--debug` must also be enabled for this option to have
any effect. (<a href="../lib/octocatalog-diff/cli/options/debug_bootstrap.rb">debug_bootstrap.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--default-header </code></pre>
</td>
<td valign=top>
Print default header with output
</td>
<td valign=top>
Provide ability to set custom header or to display no header at all (<a href="../lib/octocatalog-diff/cli/options/header.rb">header.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--display-datatype-changes
--no-display-datatype-changes </code></pre>
</td>
<td valign=top>
Display changes in data type even when strings match
</td>
<td valign=top>
Toggle on or off the display of data type changes when the string representation
is the same. For example with this enabled, '42' (the string) and 42 (the integer)
will be displayed as a difference. With this disabled, this is not displayed as a
difference. (<a href="../lib/octocatalog-diff/cli/options/display_datatype_changes.rb">display_datatype_changes.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--display-detail-add
--no-display-detail-add </code></pre>
</td>
<td valign=top>
Display parameters and other details for added resources
</td>
<td valign=top>
Provide ability to display details of 'added' resources in the output. (<a href="../lib/octocatalog-diff/cli/options/display_detail_add.rb">display_detail_add.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--display-source
--no-display-source </code></pre>
</td>
<td valign=top>
Show source file and line for each difference
</td>
<td valign=top>
Display source filename and line number for diffs (<a href="../lib/octocatalog-diff/cli/options/display_source_file_line.rb">display_source_file_line.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--enc PATH</code></pre>
</td>
<td valign=top>
Path to ENC script, relative to checkout directory or absolute
</td>
<td valign=top>
Path to external node classifier, relative to the base directory of the checkout. (<a href="../lib/octocatalog-diff/cli/options/enc.rb">enc.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--enc-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override parameter from ENC globally
</td>
<td valign=top>
Allow override of ENC parameters on the command line. ENC parameter overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. For parameters nested in hashes, use `::` as the delimiter. (<a href="../lib/octocatalog-diff/cli/options/enc_override.rb">enc_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--environment STRING</code></pre>
</td>
<td valign=top>
Environment for catalog compilation globally
</td>
<td valign=top>
Specify the environment to use when compiling the catalog. This is useful only in conjunction
with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/environment.rb">environment.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--fact-file STRING</code></pre>
</td>
<td valign=top>
Override fact globally
</td>
<td valign=top>
Allow an existing fact file to be provided, to avoid pulling facts from PuppetDB. (<a href="../lib/octocatalog-diff/cli/options/fact_file.rb">fact_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--fact-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override fact globally
</td>
<td valign=top>
Allow override of facts on the command line. Fact overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. (<a href="../lib/octocatalog-diff/cli/options/fact_override.rb">fact_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--facts-terminus STRING</code></pre>
</td>
<td valign=top>
Facts terminus: one of yaml, facter
</td>
<td valign=top>
Get the facts terminus. Generally this is 'yaml' and a fact file will be loaded from PuppetDB or
elsewhere in the environment. However it can be set to 'facter' which will run facter on the host
on which this is running. (<a href="../lib/octocatalog-diff/cli/options/facts_terminus.rb">facts_terminus.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--filters FILTER1[,FILTER2[,...]]</code></pre>
</td>
<td valign=top>
Filters to apply
</td>
<td valign=top>
Specify one or more filters to apply to the results of the catalog difference.
For a list of available filters and further explanation, please refer to
<a href="advanced-filter.md">Filtering results</a>. (<a href="../lib/octocatalog-diff/cli/options/filters.rb">filters.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-f FROM_BRANCH
--from FROM_BRANCH</code></pre>
</td>
<td valign=top>
Branch you are coming from
</td>
<td valign=top>
Set the 'from' and 'to' branches, which is used to compile catalogs. A branch of '.' means to use
the current contents of the base code directory without any git checkouts. (<a href="../lib/octocatalog-diff/cli/options/to_from_branch.rb">to_from_branch.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-catalog FILENAME</code></pre>
</td>
<td valign=top>
Use a pre-compiled catalog 'from'
</td>
<td valign=top>
If pre-compiled catalogs are available, these can be used to short-circuit the build process.
These files must exist and be in Puppet catalog format. (<a href="../lib/octocatalog-diff/cli/options/existing_catalogs.rb">existing_catalogs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-command-line STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Command line arguments for the from branch
</td>
<td valign=top>
Provide additional command line flags to set when running Puppet to compile catalogs. (<a href="../lib/octocatalog-diff/cli/options/command_line.rb">command_line.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-create-symlinks STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Symlinks to create for the from branch
</td>
<td valign=top>
Specify which directories from the base should be symlinked into the temporary compilation
environment. This is useful only in conjunction with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/create_symlinks.rb">create_symlinks.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-enc PATH</code></pre>
</td>
<td valign=top>
Path to ENC script (for the from catalog only)
</td>
<td valign=top>
Path to external node classifier, relative to the base directory of the checkout. (<a href="../lib/octocatalog-diff/cli/options/enc.rb">enc.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-enc-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override parameter from ENC for the from branch
</td>
<td valign=top>
Allow override of ENC parameters on the command line. ENC parameter overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. For parameters nested in hashes, use `::` as the delimiter. (<a href="../lib/octocatalog-diff/cli/options/enc_override.rb">enc_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-environment STRING</code></pre>
</td>
<td valign=top>
Environment for catalog compilation for the from branch
</td>
<td valign=top>
Specify the environment to use when compiling the catalog. This is useful only in conjunction
with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/environment.rb">environment.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-fact-file STRING</code></pre>
</td>
<td valign=top>
Override fact for the from branch
</td>
<td valign=top>
Allow an existing fact file to be provided, to avoid pulling facts from PuppetDB. (<a href="../lib/octocatalog-diff/cli/options/fact_file.rb">fact_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-fact-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override fact for the from branch
</td>
<td valign=top>
Allow override of facts on the command line. Fact overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. (<a href="../lib/octocatalog-diff/cli/options/fact_override.rb">fact_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-hiera-config STRING</code></pre>
</td>
<td valign=top>
Full or relative path to global Hiera configuration file for the from branch
</td>
<td valign=top>
Specify a relative path to the Hiera yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_config.rb">hiera_config.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-hiera-path STRING</code></pre>
</td>
<td valign=top>
Path to hiera data directory, relative to top directory of repository for the from branch
</td>
<td valign=top>
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-hiera-path-strip STRING</code></pre>
</td>
<td valign=top>
Path prefix to strip when munging hiera.yaml for the from branch
</td>
<td valign=top>
Specify the path to strip off the datadir to munge hiera.yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_path_strip.rb">hiera_path_strip.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-binary STRING</code></pre>
</td>
<td valign=top>
Full path to puppet binary for the from branch
</td>
<td valign=top>
Set --puppet-binary, --to-puppet-binary, --from-puppet-binary (<a href="../lib/octocatalog-diff/cli/options/puppet_binary.rb">puppet_binary.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master STRING</code></pre>
</td>
<td valign=top>
Hostname or Hostname:PortNumber for Puppet Master for the from branch
</td>
<td valign=top>
Specify the hostname, or hostname:port, for the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master.rb">puppet_master.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-api-version STRING</code></pre>
</td>
<td valign=top>
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) for the from branch
</td>
<td valign=top>
Specify the API version to use for the Puppet Master. This makes it possible to authenticate to a
version 3.x PuppetMaster by specifying the API version as 2, or for a version 4.x PuppetMaster by
specifying API version as 3. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_api_version.rb">puppet_master_api_version.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-ssl-ca STRING</code></pre>
</td>
<td valign=top>
Full path to CA certificate that signed the Puppet Master certificate for the from branch
</td>
<td valign=top>
Specify the CA certificate for Puppet Master. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_ca.rb">puppet_master_ssl_ca.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-ssl-client-cert STRING</code></pre>
</td>
<td valign=top>
Full path to certificate file for SSL client auth to Puppet Master for the from branch
</td>
<td valign=top>
Specify the SSL client certificate for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_cert.rb">puppet_master_ssl_client_cert.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-ssl-client-key STRING</code></pre>
</td>
<td valign=top>
Full path to key file for SSL client auth to Puppet Master for the from branch
</td>
<td valign=top>
Specify the SSL client key for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_key.rb">puppet_master_ssl_client_key.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-timeout STRING</code></pre>
</td>
<td valign=top>
Puppet Master catalog retrieval timeout in seconds for the from branch
</td>
<td valign=top>
Specify a timeout for retrieving a catalog from a Puppet master / Puppet server.
This timeout is specified in seconds. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_timeout.rb">puppet_master_timeout.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-token STRING</code></pre>
</td>
<td valign=top>
PE RBAC token to authenticate to the Puppetserver API v4 for the from branch
</td>
<td valign=top>
Specify a PE RBAC token used to authenticate to Puppetserver for v4
catalog API calls. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token.rb">puppet_master_token.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppet-master-token-file STRING</code></pre>
</td>
<td valign=top>
File containing PE RBAC token to authenticate to the Puppetserver API v4 for the from branch
</td>
<td valign=top>
Specify a path to a file containing a PE RBAC token used to authenticate to the
Puppetserver for a v4 catalog API call. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token_file.rb">puppet_master_token_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-puppetdb
--no-from-puppetdb </code></pre>
</td>
<td valign=top>
Pull "from" catalog from PuppetDB instead of compiling
</td>
<td valign=top>
Set --from-puppetdb to pull most recent catalog from PuppetDB instead of compiling (<a href="../lib/octocatalog-diff/cli/options/from_puppetdb.rb">from_puppetdb.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--from-save-catalog STRING</code></pre>
</td>
<td valign=top>
Save intermediate catalogs into files for the from branch
</td>
<td valign=top>
Allow catalogs to be saved to a file before they are diff'd. (<a href="../lib/octocatalog-diff/cli/options/save_catalog.rb">save_catalog.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--header STRING</code></pre>
</td>
<td valign=top>
Specify header for output
</td>
<td valign=top>
Provide ability to set custom header or to display no header at all (<a href="../lib/octocatalog-diff/cli/options/header.rb">header.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--hiera-config STRING</code></pre>
</td>
<td valign=top>
Full or relative path to global Hiera configuration file globally
</td>
<td valign=top>
Specify a relative path to the Hiera yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_config.rb">hiera_config.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--hiera-path STRING</code></pre>
</td>
<td valign=top>
Path to hiera data directory, relative to top directory of repository globally
</td>
<td valign=top>
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--hiera-path-strip STRING</code></pre>
</td>
<td valign=top>
Path prefix to strip when munging hiera.yaml globally
</td>
<td valign=top>
Specify the path to strip off the datadir to munge hiera.yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_path_strip.rb">hiera_path_strip.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-n HOSTNAME1[,HOSTNAME2[,...]]
--hostname HOSTNAME1[,HOSTNAME2[,...]]</code></pre>
</td>
<td valign=top>
Use PuppetDB facts from last run of a hostname or a comma separated list of multiple hostnames
</td>
<td valign=top>
Set hostname, which is used to look up facts in PuppetDB, and in the header of diff display.
This option can recieve a single hostname, or a comma separated list of
multiple hostnames, which are split into an Array. Multiple hostnames do not
work with the `catalog-only` or `bootstrap-then-exit` options. (<a href="../lib/octocatalog-diff/cli/options/hostname.rb">hostname.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--ignore "Type1[Title1],Type2[Title2],..."</code></pre>
</td>
<td valign=top>
More resources to ignore in format type[title]
</td>
<td valign=top>
Options used when comparing catalogs - set ignored changes. (<a href="../lib/octocatalog-diff/cli/options/ignore.rb">ignore.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--ignore-attr "attr1,attr2,..."</code></pre>
</td>
<td valign=top>
Attributes to ignore
</td>
<td valign=top>
Specify attributes to ignore (<a href="../lib/octocatalog-diff/cli/options/ignore_attr.rb">ignore_attr.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--ignore-tags STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Specify tags to ignore
</td>
<td valign=top>
Provide ability to set one or more tags, which will cause catalog-diff
to ignore any changes for any defined type where this tag is set. (<a href="../lib/octocatalog-diff/cli/options/ignore_tags.rb">ignore_tags.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--include-tags
--no-include-tags </code></pre>
</td>
<td valign=top>
Include changes to tags in the diff output
</td>
<td valign=top>
Options used when comparing catalogs - tags are generally ignored; you can un-ignore them. (<a href="../lib/octocatalog-diff/cli/options/include_tags.rb">include_tags.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--master-cache-branch BRANCH</code></pre>
</td>
<td valign=top>
Branch to cache
</td>
<td valign=top>
Allow override of the branch that is cached. This defaults to 'origin/master'. (<a href="../lib/octocatalog-diff/cli/options/master_cache_branch.rb">master_cache_branch.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-enc </code></pre>
</td>
<td valign=top>
Disable ENC
</td>
<td valign=top>
Path to external node classifier, relative to the base directory of the checkout. (<a href="../lib/octocatalog-diff/cli/options/enc.rb">enc.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-header </code></pre>
</td>
<td valign=top>
Do not print a header
</td>
<td valign=top>
Provide ability to set custom header or to display no header at all (<a href="../lib/octocatalog-diff/cli/options/header.rb">header.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-hiera-config </code></pre>
</td>
<td valign=top>
Disable hiera config file installation
</td>
<td valign=top>
Specify a relative path to the Hiera yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_config.rb">hiera_config.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-hiera-path </code></pre>
</td>
<td valign=top>
Do not use any default hiera path settings
</td>
<td valign=top>
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-hiera-path-strip </code></pre>
</td>
<td valign=top>
Do not use any default hiera path strip settings
</td>
<td valign=top>
Specify the path to strip off the datadir to munge hiera.yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_path_strip.rb">hiera_path_strip.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--no-ignore-tags </code></pre>
</td>
<td valign=top>
Disable ignoring based on tags
</td>
<td valign=top>
Provide ability to set one or more tags, which will cause catalog-diff
to ignore any changes for any defined type where this tag is set. (<a href="../lib/octocatalog-diff/cli/options/ignore_tags.rb">ignore_tags.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-o FILENAME
--output-file FILENAME</code></pre>
</td>
<td valign=top>
Output results into FILENAME
</td>
<td valign=top>
Output file option (<a href="../lib/octocatalog-diff/cli/options/output_file.rb">output_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--output-format FORMAT</code></pre>
</td>
<td valign=top>
Output format: text,json,legacy_json
</td>
<td valign=top>
Output format option. 'text' is human readable text, 'json' is an array of differences
identified by human readable keys (the preferred octocatalog-diff 1.x format), and 'legacy_json' is an
array of differences, where each difference is an array (the octocatalog-diff 0.x format). (<a href="../lib/octocatalog-diff/cli/options/output_format.rb">output_format.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--override-script-path DIRNAME</code></pre>
</td>
<td valign=top>
Directory with scripts to override built-ins
</td>
<td valign=top>
Provide an optional directory to override default built-in scripts such as git checkout
and puppet version determination. (<a href="../lib/octocatalog-diff/cli/options/override_script_path.rb">override_script_path.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--parallel
--no-parallel </code></pre>
</td>
<td valign=top>
Enable or disable parallel processing
</td>
<td valign=top>
Disable or enable parallel processing of catalogs. (<a href="../lib/octocatalog-diff/cli/options/parallel.rb">parallel.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--parser PARSER_NAME</code></pre>
</td>
<td valign=top>
Specify parser (default, future)
</td>
<td valign=top>
Enable future parser for both branches or for just one (<a href="../lib/octocatalog-diff/cli/options/parser.rb">parser.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--parser-from PARSER_NAME</code></pre>
</td>
<td valign=top>
Specify parser (default, future)
</td>
<td valign=top>
Enable future parser for both branches or for just one (<a href="../lib/octocatalog-diff/cli/options/parser.rb">parser.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--parser-to PARSER_NAME</code></pre>
</td>
<td valign=top>
Specify parser (default, future)
</td>
<td valign=top>
Enable future parser for both branches or for just one (<a href="../lib/octocatalog-diff/cli/options/parser.rb">parser.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pass-env-vars VAR1[,VAR2[,...]]</code></pre>
</td>
<td valign=top>
Environment variables to pass
</td>
<td valign=top>
One or more environment variables that should be made available to the Puppet binary when parsing
the catalog. For example, --pass-env-vars FOO,BAR will make the FOO and BAR environment variables
available. Setting these variables is your responsibility outside of octocatalog-diff. (<a href="../lib/octocatalog-diff/cli/options/pass_env_vars.rb">pass_env_vars.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-ssl-ca FILENAME</code></pre>
</td>
<td valign=top>
CA certificate that signed the ENC API certificate
</td>
<td valign=top>
Specify the CA certificate for the Puppet Enterprise ENC. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (<a href="../lib/octocatalog-diff/cli/options/pe_enc_ssl_ca.rb">pe_enc_ssl_ca.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-ssl-client-cert FILENAME</code></pre>
</td>
<td valign=top>
SSL client certificate to connect to PE ENC
</td>
<td valign=top>
Specify the client certificate for connecting to the Puppet Enterprise ENC. This must be specified along with
--pe-enc-ssl-client-key in order to work. (<a href="../lib/octocatalog-diff/cli/options/pe_enc_ssl_client_cert.rb">pe_enc_ssl_client_cert.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-ssl-client-key FILENAME</code></pre>
</td>
<td valign=top>
SSL client key to connect to PE ENC
</td>
<td valign=top>
Specify the client key for connecting to Puppet Enterprise ENC. This must be specified along with
--pe-enc-ssl-client-cert in order to work. (<a href="../lib/octocatalog-diff/cli/options/pe_enc_ssl_client_key.rb">pe_enc_ssl_client_key.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-token TOKEN</code></pre>
</td>
<td valign=top>
Token to access the Puppet Enterprise ENC API
</td>
<td valign=top>
Specify the access token to access the Puppet Enterprise ENC. Refer to
https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
details on generating and obtaining a token. Use this option to specify the text
of the token. (Use --pe-enc-token-file to read the content of the token from a file.) (<a href="../lib/octocatalog-diff/cli/options/pe_enc_token.rb">pe_enc_token.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-token-file PATH</code></pre>
</td>
<td valign=top>
Path containing token for PE node classifier, relative or absolute
</td>
<td valign=top>
Specify the access token to access the Puppet Enterprise ENC. Refer to
https://docs.puppet.com/pe/latest/nc_forming_requests.html#authentication for
details on generating and obtaining a token. Use this option if the token is stored
in a file, to read the content of the token from the file. (<a href="../lib/octocatalog-diff/cli/options/pe_enc_token_file.rb">pe_enc_token_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--pe-enc-url URL</code></pre>
</td>
<td valign=top>
Base URL for Puppet Enterprise ENC endpoint
</td>
<td valign=top>
Specify the URL to the Puppet Enterprise ENC API. By default, the node classifier service
listens on port 4433 and all endpoints are relative to the /classifier-api/ path. That means
the likely value for this option will be something like:
https://your-pe-console-server:4433/classifier-api (<a href="../lib/octocatalog-diff/cli/options/pe_enc_url.rb">pe_enc_url.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--preserve-environments
--no-preserve-environments </code></pre>
</td>
<td valign=top>
Enable or disable environment preservation
</td>
<td valign=top>
Preserve the `environments` directory from the repository when compiling the catalog. Likely
requires some combination of `--to-environment`, `--from-environment`, and/or `--create-symlinks`
to work correctly. (<a href="../lib/octocatalog-diff/cli/options/preserve_environments.rb">preserve_environments.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-binary STRING</code></pre>
</td>
<td valign=top>
Full path to puppet binary globally
</td>
<td valign=top>
Set --puppet-binary, --to-puppet-binary, --from-puppet-binary (<a href="../lib/octocatalog-diff/cli/options/puppet_binary.rb">puppet_binary.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master STRING</code></pre>
</td>
<td valign=top>
Hostname or Hostname:PortNumber for Puppet Master globally
</td>
<td valign=top>
Specify the hostname, or hostname:port, for the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master.rb">puppet_master.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-api-version STRING</code></pre>
</td>
<td valign=top>
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) globally
</td>
<td valign=top>
Specify the API version to use for the Puppet Master. This makes it possible to authenticate to a
version 3.x PuppetMaster by specifying the API version as 2, or for a version 4.x PuppetMaster by
specifying API version as 3. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_api_version.rb">puppet_master_api_version.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-ssl-ca STRING</code></pre>
</td>
<td valign=top>
Full path to CA certificate that signed the Puppet Master certificate globally
</td>
<td valign=top>
Specify the CA certificate for Puppet Master. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_ca.rb">puppet_master_ssl_ca.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-ssl-client-cert STRING</code></pre>
</td>
<td valign=top>
Full path to certificate file for SSL client auth to Puppet Master globally
</td>
<td valign=top>
Specify the SSL client certificate for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_cert.rb">puppet_master_ssl_client_cert.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-ssl-client-key STRING</code></pre>
</td>
<td valign=top>
Full path to key file for SSL client auth to Puppet Master globally
</td>
<td valign=top>
Specify the SSL client key for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_key.rb">puppet_master_ssl_client_key.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-timeout STRING</code></pre>
</td>
<td valign=top>
Puppet Master catalog retrieval timeout in seconds globally
</td>
<td valign=top>
Specify a timeout for retrieving a catalog from a Puppet master / Puppet server.
This timeout is specified in seconds. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_timeout.rb">puppet_master_timeout.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-token STRING</code></pre>
</td>
<td valign=top>
PE RBAC token to authenticate to the Puppetserver API v4 globally
</td>
<td valign=top>
Specify a PE RBAC token used to authenticate to Puppetserver for v4
catalog API calls. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token.rb">puppet_master_token.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppet-master-token-file STRING</code></pre>
</td>
<td valign=top>
File containing PE RBAC token to authenticate to the Puppetserver API v4 globally
</td>
<td valign=top>
Specify a path to a file containing a PE RBAC token used to authenticate to the
Puppetserver for a v4 catalog API call. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token_file.rb">puppet_master_token_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-api-version N</code></pre>
</td>
<td valign=top>
Version of PuppetDB API (3 or 4)
</td>
<td valign=top>
Specify the API version to use for the PuppetDB. The current values supported are '3' or '4', and '4' is
the default. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_api_version.rb">puppetdb_api_version.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-package-inventory
--no-puppetdb-package-inventory </code></pre>
</td>
<td valign=top>
Include Puppet Enterprise package inventory data, if found
</td>
<td valign=top>
When pulling facts from PuppetDB in a Puppet Enterprise environment, also include
the Puppet Enterprise Package Inventory data in the fact results, if available.
Generally you should not need to specify this, but including the package inventory
data will produce a more accurate set of input facts for environments using
package inventory. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_package_inventory.rb">puppetdb_package_inventory.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-ssl-ca FILENAME</code></pre>
</td>
<td valign=top>
CA certificate that signed the PuppetDB certificate
</td>
<td valign=top>
Specify the CA certificate for PuppetDB. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_ssl_ca.rb">puppetdb_ssl_ca.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-ssl-client-cert FILENAME</code></pre>
</td>
<td valign=top>
SSL client certificate to connect to PuppetDB
</td>
<td valign=top>
Specify the client certificate for connecting to PuppetDB. This must be specified along with
--puppetdb-ssl-client-key in order to work. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_ssl_client_cert.rb">puppetdb_ssl_client_cert.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-ssl-client-key FILENAME</code></pre>
</td>
<td valign=top>
SSL client key to connect to PuppetDB
</td>
<td valign=top>
Specify the client key for connecting to PuppetDB. This must be specified along with
--puppetdb-ssl-client-cert in order to work. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_ssl_client_key.rb">puppetdb_ssl_client_key.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-ssl-client-password PASSWORD</code></pre>
</td>
<td valign=top>
Password for SSL client key to connect to PuppetDB
</td>
<td valign=top>
Specify the password for a PEM or PKCS12 private key on the command line.
Note that `--puppetdb-ssl-client-password-file` is slightly more secure because
the text of the password won't appear in the process list. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_ssl_client_password.rb">puppetdb_ssl_client_password.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-ssl-client-password-file FILENAME</code></pre>
</td>
<td valign=top>
Read password for SSL client key from a file
</td>
<td valign=top>
Specify the password for a PEM or PKCS12 private key, by reading it from a file. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_ssl_client_password_file.rb">puppetdb_ssl_client_password_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-token TOKEN</code></pre>
</td>
<td valign=top>
Token to access the PuppetDB API
</td>
<td valign=top>
Specify the PE RBAC token to access the PuppetDB API. Refer to
https://puppet.com/docs/pe/latest/rbac/rbac_token_auth_intro.html#generate-a-token-using-puppet-access
for details on generating and obtaining a token. Use this option to specify the text
of the token. (Use --puppetdb-token-file to read the content of the token from a file.) (<a href="../lib/octocatalog-diff/cli/options/puppetdb_token.rb">puppetdb_token.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-token-file PATH</code></pre>
</td>
<td valign=top>
Path containing token for PuppetDB API, relative or absolute
</td>
<td valign=top>
Specify the PE RBAC token to access the PuppetDB API. Refer to
https://puppet.com/docs/pe/latest/rbac/rbac_token_auth_intro.html#generate-a-token-using-puppet-access
for details on generating and obtaining a token. Use this option to specify the text
in a file, to read the content of the token from the file. (<a href="../lib/octocatalog-diff/cli/options/puppetdb_token_file.rb">puppetdb_token_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--puppetdb-url URL</code></pre>
</td>
<td valign=top>
PuppetDB base URL
</td>
<td valign=top>
Specify the base URL for PuppetDB. This will generally look like https://puppetdb.yourdomain.com:8081 (<a href="../lib/octocatalog-diff/cli/options/puppetdb_url.rb">puppetdb_url.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-q
--quiet
--no-quiet </code></pre>
</td>
<td valign=top>
Quiet (no status messages except errors)
</td>
<td valign=top>
Quiet option (<a href="../lib/octocatalog-diff/cli/options/quiet.rb">quiet.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--retry-failed-catalog N</code></pre>
</td>
<td valign=top>
Retry building a failed catalog N times
</td>
<td valign=top>
Transient errors can cause catalog compilation problems. This adds an option to retry
a failed catalog multiple times before kicking out an error message. (<a href="../lib/octocatalog-diff/cli/options/retry_failed_catalog.rb">retry_failed_catalog.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--safe-to-delete-cached-master-dir PATH</code></pre>
</td>
<td valign=top>
OK to delete cached master directory at this path
</td>
<td valign=top>
By specifying a directory path here, you are explicitly giving permission to the program
to delete it if it believes it needs to be created (e.g., if the SHA has changed of the
cached directory). (<a href="../lib/octocatalog-diff/cli/options/safe_to_delete_cached_master_dir.rb">safe_to_delete_cached_master_dir.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--save-catalog STRING</code></pre>
</td>
<td valign=top>
Save intermediate catalogs into files globally
</td>
<td valign=top>
Allow catalogs to be saved to a file before they are diff'd. (<a href="../lib/octocatalog-diff/cli/options/save_catalog.rb">save_catalog.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--storeconfigs
--no-storeconfigs </code></pre>
</td>
<td valign=top>
Enable integration with puppetdb for collected resources
</td>
<td valign=top>
Set storeconfigs (integration with PuppetDB for collected resources) (<a href="../lib/octocatalog-diff/cli/options/storeconfigs.rb">storeconfigs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--suppress-absent-file-details
--no-suppress-absent-file-details </code></pre>
</td>
<td valign=top>
Suppress certain attributes of absent files
</td>
<td valign=top>
If enabled, this option will suppress changes to certain attributes of a file, if the
file is specified to be 'absent' in the target catalog. Suppressed changes in this case
include user, group, mode, and content, because a removed file has none of those.
<i>This option is DEPRECATED; please use <code>--filters AbsentFile</code> instead.</i> (<a href="../lib/octocatalog-diff/cli/options/suppress_absent_file_details.rb">suppress_absent_file_details.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>-t TO_BRANCH
--to TO_BRANCH</code></pre>
</td>
<td valign=top>
Branch you are going to
</td>
<td valign=top>
Set the 'from' and 'to' branches, which is used to compile catalogs. A branch of '.' means to use
the current contents of the base code directory without any git checkouts. (<a href="../lib/octocatalog-diff/cli/options/to_from_branch.rb">to_from_branch.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-catalog FILENAME</code></pre>
</td>
<td valign=top>
Use a pre-compiled catalog 'to'
</td>
<td valign=top>
If pre-compiled catalogs are available, these can be used to short-circuit the build process.
These files must exist and be in Puppet catalog format. (<a href="../lib/octocatalog-diff/cli/options/existing_catalogs.rb">existing_catalogs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-command-line STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Command line arguments for the to branch
</td>
<td valign=top>
Provide additional command line flags to set when running Puppet to compile catalogs. (<a href="../lib/octocatalog-diff/cli/options/command_line.rb">command_line.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-create-symlinks STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Symlinks to create for the to branch
</td>
<td valign=top>
Specify which directories from the base should be symlinked into the temporary compilation
environment. This is useful only in conjunction with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/create_symlinks.rb">create_symlinks.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-enc PATH</code></pre>
</td>
<td valign=top>
Path to ENC script (for the to catalog only)
</td>
<td valign=top>
Path to external node classifier, relative to the base directory of the checkout. (<a href="../lib/octocatalog-diff/cli/options/enc.rb">enc.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-enc-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override parameter from ENC for the to branch
</td>
<td valign=top>
Allow override of ENC parameters on the command line. ENC parameter overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. For parameters nested in hashes, use `::` as the delimiter. (<a href="../lib/octocatalog-diff/cli/options/enc_override.rb">enc_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-environment STRING</code></pre>
</td>
<td valign=top>
Environment for catalog compilation for the to branch
</td>
<td valign=top>
Specify the environment to use when compiling the catalog. This is useful only in conjunction
with `--preserve-environments`. (<a href="../lib/octocatalog-diff/cli/options/environment.rb">environment.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-fact-file STRING</code></pre>
</td>
<td valign=top>
Override fact for the to branch
</td>
<td valign=top>
Allow an existing fact file to be provided, to avoid pulling facts from PuppetDB. (<a href="../lib/octocatalog-diff/cli/options/fact_file.rb">fact_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-fact-override STRING1[,STRING2[,...]]</code></pre>
</td>
<td valign=top>
Override fact for the to branch
</td>
<td valign=top>
Allow override of facts on the command line. Fact overrides can be supplied for the 'to' or 'from' catalog,
or for both. There is some attempt to handle data types here (since all items on the command line are strings)
by permitting a data type specification as well. (<a href="../lib/octocatalog-diff/cli/options/fact_override.rb">fact_override.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-hiera-config STRING</code></pre>
</td>
<td valign=top>
Full or relative path to global Hiera configuration file for the to branch
</td>
<td valign=top>
Specify a relative path to the Hiera yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_config.rb">hiera_config.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-hiera-path STRING</code></pre>
</td>
<td valign=top>
Path to hiera data directory, relative to top directory of repository for the to branch
</td>
<td valign=top>
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-hiera-path-strip STRING</code></pre>
</td>
<td valign=top>
Path prefix to strip when munging hiera.yaml for the to branch
</td>
<td valign=top>
Specify the path to strip off the datadir to munge hiera.yaml file (<a href="../lib/octocatalog-diff/cli/options/hiera_path_strip.rb">hiera_path_strip.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-binary STRING</code></pre>
</td>
<td valign=top>
Full path to puppet binary for the to branch
</td>
<td valign=top>
Set --puppet-binary, --to-puppet-binary, --from-puppet-binary (<a href="../lib/octocatalog-diff/cli/options/puppet_binary.rb">puppet_binary.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master STRING</code></pre>
</td>
<td valign=top>
Hostname or Hostname:PortNumber for Puppet Master for the to branch
</td>
<td valign=top>
Specify the hostname, or hostname:port, for the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master.rb">puppet_master.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-api-version STRING</code></pre>
</td>
<td valign=top>
Puppet Master API version (2 for Puppet 3.x, 3 for Puppet 4.x, 4 for Puppet Server >= 6.3.0) for the to branch
</td>
<td valign=top>
Specify the API version to use for the Puppet Master. This makes it possible to authenticate to a
version 3.x PuppetMaster by specifying the API version as 2, or for a version 4.x PuppetMaster by
specifying API version as 3. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_api_version.rb">puppet_master_api_version.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-ssl-ca STRING</code></pre>
</td>
<td valign=top>
Full path to CA certificate that signed the Puppet Master certificate for the to branch
</td>
<td valign=top>
Specify the CA certificate for Puppet Master. If specified, this will enable SSL verification
that the certificate being presented has been signed by this CA, and that the common name
matches the name you are using to connecting. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_ca.rb">puppet_master_ssl_ca.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-ssl-client-cert STRING</code></pre>
</td>
<td valign=top>
Full path to certificate file for SSL client auth to Puppet Master for the to branch
</td>
<td valign=top>
Specify the SSL client certificate for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_cert.rb">puppet_master_ssl_client_cert.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-ssl-client-key STRING</code></pre>
</td>
<td valign=top>
Full path to key file for SSL client auth to Puppet Master for the to branch
</td>
<td valign=top>
Specify the SSL client key for Puppet Master. This makes it possible to authenticate with a
client certificate keypair to the Puppet Master. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_ssl_client_key.rb">puppet_master_ssl_client_key.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-timeout STRING</code></pre>
</td>
<td valign=top>
Puppet Master catalog retrieval timeout in seconds for the to branch
</td>
<td valign=top>
Specify a timeout for retrieving a catalog from a Puppet master / Puppet server.
This timeout is specified in seconds. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_timeout.rb">puppet_master_timeout.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-token STRING</code></pre>
</td>
<td valign=top>
PE RBAC token to authenticate to the Puppetserver API v4 for the to branch
</td>
<td valign=top>
Specify a PE RBAC token used to authenticate to Puppetserver for v4
catalog API calls. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token.rb">puppet_master_token.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-puppet-master-token-file STRING</code></pre>
</td>
<td valign=top>
File containing PE RBAC token to authenticate to the Puppetserver API v4 for the to branch
</td>
<td valign=top>
Specify a path to a file containing a PE RBAC token used to authenticate to the
Puppetserver for a v4 catalog API call. (<a href="../lib/octocatalog-diff/cli/options/puppet_master_token_file.rb">puppet_master_token_file.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--to-save-catalog STRING</code></pre>
</td>
<td valign=top>
Save intermediate catalogs into files for the to branch
</td>
<td valign=top>
Allow catalogs to be saved to a file before they are diff'd. (<a href="../lib/octocatalog-diff/cli/options/save_catalog.rb">save_catalog.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--truncate-details
--no-truncate-details </code></pre>
</td>
<td valign=top>
Truncate details with --display-detail-add
</td>
<td valign=top>
When using `--display-detail-add` by default the details of any field will be truncated
at 80 characters. Specify `--no-truncate-details` to display the full output. This option
has no effect when `--display-detail-add` is not used. (<a href="../lib/octocatalog-diff/cli/options/truncate_details.rb">truncate_details.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--use-lcs
--no-use-lcs </code></pre>
</td>
<td valign=top>
Use the LCS algorithm to determine differences in arrays
</td>
<td valign=top>
Configures using the Longest common subsequence (LCS) algorithm to determine differences in arrays (<a href="../lib/octocatalog-diff/cli/options/use_lcs.rb">use_lcs.rb</a>)
</td>
</tr>
<tr>
<td valign=top>
<pre><code>--validate-references
--no-validate-references </code></pre>
</td>
<td valign=top>
References to validate
</td>
<td valign=top>
Confirm that each `before`, `require`, `subscribe`, and/or `notify` points to a valid
resource in the catalog. This value should be specified as an array of which of these
parameters are to be checked. (<a href="../lib/octocatalog-diff/cli/options/validate_references.rb">validate_references.rb</a>)
</td>
</tr>
</table>
## Using these options in API calls
Most of these options can also be used when making calls to the [API](/doc/dev/api.md).
Generally, parameters for the API are named corresponding to the names of the command line parameters, with dashes (`-`) converted to underscores (`_`). For example, the command line option `--hiera-config` is passed to the API as the symbol `:hiera_config`.
Each of the options above has a link to the source file where it is declared, should you wish to review the specific parameter names and data structures that are being set.
|