StormForge CLI on StormForge Documentation /v2/docs/stormforge-cli/ Recent content in StormForge CLI on StormForge Documentation Hugo en-us Common StormForge CLI workflows /v2/docs/stormforge-cli/common-cli-workflows/ Mon, 01 Jan 0001 00:00:00 +0000 /v2/docs/stormforge-cli/common-cli-workflows/ <p>The StormForge CLI lets you interact with StormForge to inspect workloads, view optimization data, and manage recommendations.</p> <p>This guide covers common workflows:</p> <ul> <li>Authenticate and configure the CLI</li> <li>Explore clusters and workloads</li> <li>Find workloads with auto-deploy enabled</li> <li>View and generate recommendations</li> <li>Query recommendation data</li> <li>Apply recommendations to workloads</li> </ul> <p>Typical workflow:</p> <pre tabindex="0"><code>Identify workload → Inspect recommendation → Apply recommendation </code></pre><p>Common workflow commands:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>stormforge get workloads --cluster &lt;cluster&gt; </span></span><span style="display:flex;"><span>stormforge get recommendations --cluster &lt;cluster&gt; --namespace &lt;namespace&gt; --name &lt;workload&gt; </span></span><span style="display:flex;"><span>stormforge apply --cluster &lt;cluster&gt; --namespace &lt;namespace&gt; --resource &lt;resource-type&gt; --name &lt;workload&gt; </span></span></code></pre></div><hr> <h2 id="in-this-guide">In this guide<a class="td-heading-self-link" href="#in-this-guide" aria-label="Heading self-link"></a></h2> <ul> <li><a href="#common-commands">Common commands</a></li> <li><a href="#get-started">Get started with the CLI</a></li> <li><a href="#explore">Explore clusters and workloads</a></li> <li><a href="#find-auto-deploy">Find workloads with auto-deploy enabled</a></li> <li><a href="#view-recs">View and generate recommendations</a></li> <li><a href="#query-recs">Query recommendation data</a></li> <li><a href="#apply-recs">Apply recommendations</a></li> </ul> <h2 id="common-commands">Common commands<a class="td-heading-self-link" href="#common-commands" aria-label="Heading self-link"></a></h2> <table class="td-initial table"> <thead> <tr> <th>Task</th> <th>Command</th> </tr> </thead> <tbody> <tr> <td>Authenticate</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-login"><code>stormforge login</code></a></td> </tr> <tr> <td>List clusters</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-get-clusters"><code>stormforge get clusters</code></a></td> </tr> <tr> <td>List workloads</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-get-workloads"><code>stormforge get workloads</code></a></td> </tr> <tr> <td>View workloads</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-view-workloads"><code>stormforge view workloads</code></a></td> </tr> <tr> <td>List recommendations</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-get-recommendations"><code>stormforge get recommendations</code></a></td> </tr> <tr> <td>Create recommendation</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-create-recommendation"><code>stormforge create recommendation</code></a></td> </tr> <tr> <td>Apply recommendations</td> <td><a href="/v2/docs/stormforge-cli/reference/#stormforge-apply"><code>stormforge apply</code></a></td> </tr> </tbody> </table> <div class="alert alert-info" role="alert"><div class="h4 alert-heading" role="heading">Using command help in the CLI</div> <p>Use the <code>--help</code> flag with any command for more information.</p> StormForge MCP server /v2/docs/stormforge-cli/mcp-server/ Mon, 01 Jan 0001 00:00:00 +0000 /v2/docs/stormforge-cli/mcp-server/ <p>The StormForge CLI includes an MCP server for connecting AI agents to StormForge.</p> <p>This page covers configuration and basic usage, using Claude as an example.</p> <h2 id="prerequisites">Prerequisites<a class="td-heading-self-link" href="#prerequisites" aria-label="Heading self-link"></a></h2> <p>Make sure the <a href="/v2/docs/stormforge-cli/#install">StormForge CLI is installed</a> and you are logged in:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>stormforge login </span></span></code></pre></div><h2 id="configure-your-ai-agent">Configure your AI agent<a class="td-heading-self-link" href="#configure-your-ai-agent" aria-label="Heading self-link"></a></h2> <p><em>This example uses Claude, but the configuration pattern applies to other MCP-compatible agents such as ChatGPT and Gemini.</em></p> <p>Add the following to your agent&rsquo;s MCP configuration. For Claude, that can be <code>~/.claude.json</code>:</p> Reference /v2/docs/stormforge-cli/reference/ Mon, 01 Jan 0001 00:00:00 +0000 /v2/docs/stormforge-cli/reference/ <h2 id="stormforge">stormforge<a class="td-heading-self-link" href="#stormforge" aria-label="Heading self-link"></a></h2> <p>StormForge Command Line Interface</p> <h3 id="synopsis">Synopsis<a class="td-heading-self-link" href="#synopsis" aria-label="Heading self-link"></a></h3> <p>Automated Kubernetes Workload Rightsizing.</p> <p>Find more information at: <a href="https://docs.stormforge.io/">https://docs.stormforge.io/</a></p> <h3 id="options">Options<a class="td-heading-self-link" href="#options" aria-label="Heading self-link"></a></h3> <pre tabindex="0"><code> --sfconfig file configuration file to use -h, --help help for stormforge </code></pre><h3 id="see-also">See also<a class="td-heading-self-link" href="#see-also" aria-label="Heading self-link"></a></h3> <ul> <li><a href="#stormforge-apply">stormforge apply</a> - Apply one or more recommendations</li> <li><a href="#stormforge-auth">stormforge auth</a> - Manage non-user authorizations</li> <li><a href="#stormforge-check">stormforge check</a> - Validate StormForge components</li> <li><a href="#stormforge-completion">stormforge completion</a> - Generate the autocompletion script for the specified shell</li> <li><a href="#stormforge-config">stormforge config</a> - Show the CLI configuration</li> <li><a href="#stormforge-create">stormforge create</a> - Create a resource</li> <li><a href="#stormforge-delete">stormforge delete</a> - Delete a resource</li> <li><a href="#stormforge-describe">stormforge describe</a> - Describe a resource</li> <li><a href="#stormforge-edit">stormforge edit</a> - Edit a resource</li> <li><a href="#stormforge-get">stormforge get</a> - Fetch resources</li> <li><a href="#stormforge-login">stormforge login</a> - Authorize the CLI</li> <li><a href="#stormforge-logout">stormforge logout</a> - Revoke the CLI authorization</li> <li><a href="#stormforge-manage">stormforge manage</a> - Manage a resource</li> <li><a href="#stormforge-mcp">stormforge mcp</a> - Run an MCP server</li> <li><a href="#stormforge-patch">stormforge patch</a> - Deploy patches to a cluster or source files</li> <li><a href="#stormforge-ping">stormforge ping</a> - Connect to the StormForge server (also see &lsquo;check connect&rsquo;)</li> <li><a href="#stormforge-version">stormforge version</a> - Show the version information</li> <li><a href="#stormforge-view">stormforge view</a> - View pages of impact data</li> </ul> <h2 id="stormforge-apply">stormforge apply<a class="td-heading-self-link" href="#stormforge-apply" aria-label="Heading self-link"></a></h2> <p>Apply one or more recommendations</p>