/docs/7_cli_api/Recent content in CLI / API Reference on Porch DocumentationHugoen-us/docs/7_cli_api/porchctl/Mon, 01 Jan 0001 00:00:00 +0000/docs/7_cli_api/porchctl/<h2 id="overview">Overview</h2><p><code>porchctl</code> is the command-line interface for interacting with Porch. It communicates with a Kubernetes API server that has Porch installed as an aggregated API server, allowing you to manage repository registrations and packages within those repositories.</p> <h2 id="installation">Installation</h2><p>See <a href="/docs/3_getting_started/installing-porchctl/">Installing porchctl</a> for installation instructions.</p> <h2 id="global-flags">Global Flags</h2><p>These flags are available for all porchctl commands:</p> <table> <thead> <tr> <th>Flag</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--kubeconfig string</code></td> <td>Path to kubeconfig file. Only required if out-of-cluster. Can also be set via <code>KUBECONFIG</code> environment variable.</td> <td></td> </tr> <tr> <td><code>--log-flush-frequency duration</code></td> <td>Maximum seconds between log flushes</td> <td><code>5s</code></td> </tr> <tr> <td><code>--truncate-output</code></td> <td>Enable output truncation</td> <td><code>true</code></td> </tr> <tr> <td><code>-v, --v Level</code></td> <td>Log level verbosity</td> <td></td> </tr> <tr> <td><code>-h, --help</code></td> <td>Help for porchctl</td> <td></td> </tr> </tbody> </table> <h2 id="commands">Commands</h2><ul> <li> <a href="#repo">repo</a> - Manage package repositories</li> <li> <a href="#rpkg">rpkg</a> - Manage packages</li> <li> <a href="#completion">completion</a> - Generate shell autocompletion</li> <li> <a href="#version">version</a> - Print version information</li> </ul> <hr> <h2 id="repo">repo</h2><p>Manage package repositories.</p>/docs/7_cli_api/api-ref/Mon, 01 Jan 0001 00:00:00 +0000/docs/7_cli_api/api-ref/<h2 id="packages">Packages</h2><ul> <li> <a href="#porchkptdevv1alpha1">porch.kpt.dev/v1alpha1</a></li> </ul> <h2 id="porchkptdevv1alpha1">porch.kpt.dev/v1alpha1</h2><h4 id="condition">Condition</h4><p><em>Appears in:</em></p> <ul> <li> <a href="#packagerevisionstatus">PackageRevisionStatus</a></li> </ul> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Default</th> <th>Validation</th> </tr> </thead> <tbody> <tr> <td><code>type</code> <em>string</em></td> <td></td> <td></td> <td></td> </tr> <tr> <td><code>status</code> <em> <a href="#conditionstatus">ConditionStatus</a></em></td> <td></td> <td></td> <td></td> </tr> <tr> <td><code>reason</code> <em>string</em></td> <td></td> <td></td> <td></td> </tr> <tr> <td><code>message</code> <em>string</em></td> <td></td> <td></td> <td></td> </tr> </tbody> </table> <h4 id="conditionstatus">ConditionStatus</h4><p><em>Appears in:</em></p> <ul> <li> <a href="#condition">Condition</a></li> </ul> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>True</code></td> <td></td> </tr> <tr> <td><code>False</code></td> <td></td> </tr> <tr> <td><code>Unknown</code></td> <td></td> </tr> </tbody> </table> <h4 id="field">Field</h4><p>Field references a field in a resource</p> <p><em>Appears in:</em></p> <ul> <li> <a href="#resultitem">ResultItem</a></li> </ul> <table> <thead> <tr> <th>Field</th> <th>Description</th> <th>Default</th> <th>Validation</th> </tr> </thead> <tbody> <tr> <td><code>path</code> <em>string</em></td> <td>Path is the field path. This field is required.</td> <td></td> <td></td> </tr> <tr> <td><code>currentValue</code> <em>string</em></td> <td>CurrentValue is the current field value</td> <td></td> <td></td> </tr> <tr> <td><code>proposedValue</code> <em>string</em></td> <td>ProposedValue is the proposed value of the field to fix an issue.</td> <td></td> <td></td> </tr> </tbody> </table> <h4 id="file">File</h4><p>File references a file containing a resource</p>/docs/7_cli_api/crd-ref/Mon, 01 Jan 0001 00:00:00 +0000/docs/7_cli_api/crd-ref/<iframe src="https://doc.crds.dev/github.com/kptdev/porch@v1.5.7" width="100%" style="min-height:98vh; border:none;"/>