Docs: wip

sst · Mar 7, 2024 · 9936ae1 · 9936ae1
1 parent 26bcb09
commit 9936ae1
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 13 deletions.
diff --git a/www/generate.ts b/www/generate.ts
@@ -125,7 +125,7 @@ async function generateCliDoc() {
       lines.push(``, `### ${cmd.name}`, `<Segment>`);
 
       // usage
-      if (cmd.children.length) {
+      if (!cmd.children.length) {
         lines.push(
           `#### Usage`,
           `<Section type="signature">`,

diff --git a/www/src/content/docs/docs/reference/cli.mdx b/www/src/content/docs/docs/reference/cli.mdx
@@ -52,11 +52,23 @@ Print help
 
 ### version
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst version
+```
+</Section>
 Print the version
 </Segment>
 
 ### dev
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst dev [command]
+```
+</Section>
 
 <Section type="parameters">
 #### Args
@@ -68,12 +80,6 @@ Run in development mode
 
 ### secret
 <Segment>
-#### Usage
-<Section type="signature">
-```
-sst secret
-```
-</Section>
 
 <Section type="parameters">
 #### Subcommands
@@ -124,6 +130,12 @@ List all secrets
 
 ### shell
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst shell [command]
+```
+</Section>
 
 <Section type="parameters">
 #### Args
@@ -135,43 +147,73 @@ Run command with all resource linked in environment
 
 ### install
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst install
+```
+</Section>
 Install dependencies specified in sst.config.ts
 </Segment>
 
 ### deploy
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst deploy
+```
+</Section>
 Deploy your application
 </Segment>
 
 ### remove
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst remove
+```
+</Section>
 Remove your application
 </Segment>
 
 ### refresh
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst refresh
+```
+</Section>
 
 </Segment>
 
 ### cancel
 <Segment>
+#### Usage
+<Section type="signature">
+```
+sst cancel
+```
+</Section>
 Cancel any pending deploys
 </Segment>
 
 ### init
 <Segment>
-
-</Segment>
-
-### state
-<Segment>
 #### Usage
 <Section type="signature">
 ```
-sst state
+sst init
 ```
 </Section>
 
+</Segment>
+
+### state
+<Segment>
+
 <Section type="parameters">
 #### Subcommands
 - <p>[<code class="key">edit</code>](#state-edit)</p>