feat: updated cli docs with cli commands#21
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/cli/commands.md (1 hunks)
- sidebars.js (1 hunks)
Additional context used
LanguageTool
docs/cli/commands.md
[style] ~191-~191: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...service-file-upload|fu| If you want to have fileUpload setup in the project. ...(REP_WANT_TO_VB)
Markdownlint
docs/cli/commands.md
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
114-114: Column: 15
Hard tabs(MD010, no-hard-tabs)
154-154: Column: 15
Hard tabs(MD010, no-hard-tabs)
155-155: Column: 12
Hard tabs(MD010, no-hard-tabs)
165-165: Column: 27
Hard tabs(MD010, no-hard-tabs)
179-179: Column: 24
Hard tabs(MD010, no-hard-tabs)
122-122: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
131-131: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
137-137: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
140-140: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
193-193: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
205-205: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
206-206: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
40-40: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
35-35: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
101-101: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
145-145: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
105-105: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
18-18: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
24-24: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
43-43: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
102-102: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
110-110: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
146-146: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
157-157: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
82-82: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
141-141: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
207-207: null
Files should end with a single newline character(MD047, single-trailing-newline)
163-163: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
165-165: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
179-179: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
164-164: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
166-166: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
180-180: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
Additional comments not posted (7)
sidebars.js (1)
78-78: Sidebar Update ApprovedThe addition of
'cli/commands'to the sidebar under the 'CLI' category is consistent with the structure and naming conventions of the other items. This properly reflects the PR objectives.docs/cli/commands.md (6)
10-34: Comprehensive Documentation for Build CommandThe documentation for the
stencil buildcommand is well-detailed, including examples, arguments, and options. This aligns well with the PR objectives of updating CLI documentation.Tools
Markdownlint
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
18-18: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
24-24: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
35-62: Comprehensive Documentation for Start CommandThe documentation for the
stencil startcommand is thorough, providing clear examples and a detailed description of options and arguments.Tools
Markdownlint
40-40: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
35-35: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
43-43: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
66-80: Add Command DocumentationThe documentation for the
stencil addcommand is concise and clear, explaining the purpose and usage of the command effectively.Tools
Markdownlint
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
81-94: Info and List Commands DocumentationBoth
stencil infoandstencil listcommands are documented succinctly, providing essential information about their functionalities.Tools
Markdownlint
86-86: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
82-82: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
96-120: Detailed Documentation for Docker CommandThe
stencil dockercommand section is detailed, including descriptions of specific setups and arguments. This section effectively informs users about the command's capabilities and configurations.Tools
Markdownlint
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
114-114: Column: 15
Hard tabs(MD010, no-hard-tabs)
101-101: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
105-105: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
102-102: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
110-110: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
98-98: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
138-204: Generate Command DocumentationThe
stencil generatecommand documentation is extensive, covering a wide range of schematics and options. This section is crucial for users needing detailed guidance on file generation.Tools
LanguageTool
[style] ~191-~191: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...service-file-upload|fu| If you want to have fileUpload setup in the project. ...(REP_WANT_TO_VB)
Markdownlint
154-154: Column: 15
Hard tabs(MD010, no-hard-tabs)
155-155: Column: 12
Hard tabs(MD010, no-hard-tabs)
165-165: Column: 27
Hard tabs(MD010, no-hard-tabs)
179-179: Column: 24
Hard tabs(MD010, no-hard-tabs)
140-140: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
193-193: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
145-145: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
146-146: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
157-157: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
141-141: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
163-163: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
165-165: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
179-179: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
164-164: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
166-166: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
180-180: Expected: 3; Actual: 1; Too few cells, row will be missing data
Table column count(MD056, table-column-count)
|
|
||
| Creates a docker service/container for given prompt. | ||
| - Tooling specific setup | ||
| - Creates a folder with the given `<service>` inside docker directory |
There was a problem hiding this comment.
Fix Indentation in Markdown Lists
There are inconsistencies in the indentation for unordered lists. This should be corrected to ensure uniformity and adherence to markdown best practices.
- - Creates a folder with the given `<service>` inside docker directory
- - Creates a docker compose or updates existing docker compose with desired `<service>`
+ - Creates a folder with the given `<service>` inside docker directory
+ - Creates a docker compose or updates existing docker compose with desired `<service>`Also applies to: 108-108
Tools
Markdownlint
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 7
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli/commands.md (1 hunks)
Additional context used
LanguageTool
docs/cli/commands.md
[style] ~188-~188: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...service-file-upload|fu| If you want to have fileUpload setup in the project. ...(REP_WANT_TO_VB)
Markdownlint
docs/cli/commands.md
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
108-108: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
114-114: Column: 15
Hard tabs(MD010, no-hard-tabs)
154-154: Column: 15
Hard tabs(MD010, no-hard-tabs)
155-155: Column: 12
Hard tabs(MD010, no-hard-tabs)
164-164: Column: 27
Hard tabs(MD010, no-hard-tabs)
177-177: Column: 24
Hard tabs(MD010, no-hard-tabs)
122-122: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
131-131: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
137-137: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
140-140: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
190-190: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
202-202: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
203-203: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
40-40: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
35-35: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
101-101: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
145-145: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
105-105: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
18-18: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
24-24: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
43-43: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
102-102: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
110-110: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
146-146: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
157-157: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
191-191: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
82-82: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
90-90: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
98-98: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
141-141: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
204-204: null
Files should end with a single newline character(MD047, single-trailing-newline)
Additional comments not posted (1)
docs/cli/commands.md (1)
106-106: Fix Indentation in Markdown ListsThere are inconsistencies in the indentation for unordered lists. This should be corrected to ensure uniformity and adherence to markdown best practices.
- - Creates a folder with the given `<service>` inside docker directory + - Creates a folder with the given `<service>` inside docker directoryTools
Markdownlint
106-106: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
| ## Info Command | ||
|
|
||
| ``` | ||
| stencil info |
There was a problem hiding this comment.
Consider adding an example output for the Info Command.
Example outputs are particularly useful for simple commands to confirm their successful execution.
+ # Example output:
+ $ Stencil package version: 1.0.0
+ $ System info: Windows 10, 64-bitCommittable suggestion was skipped due to low confidence.
| ## List Command | ||
|
|
||
| ``` | ||
| stencil list |
There was a problem hiding this comment.
Consider adding an example output for the List Command.
Showing users what to expect from the output can help them understand the command's utility.
+ # Example output:
+ $ Installed services: Service1, Service2
+ $ Package managers: npm, yarnCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| stencil list | |
| stencil list | |
| # Example output: | |
| $ Installed services: Service1, Service2 | |
| $ Package managers: npm, yarn |
| Imports a library that has been packaged as a **nest library**, running its install schematic. | ||
|
|
||
| ```bash | ||
| stencil add <name> [options] |
There was a problem hiding this comment.
Consider adding an example output for the Add Command.
Providing output examples can help users verify that they have executed the command correctly.
+ # Example output:
+ $ Library 'name' added successfully.Committable suggestion was skipped due to low confidence.
| stencil docker <services...> | ||
| stencil do <services...> | ||
| ``` |
There was a problem hiding this comment.
Consider adding an example output for the Docker Command.
Providing example outputs can demystify what might otherwise be a complex command for users.
+ # Example output:
+ $ Docker service 'service1' created successfully.Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
101-101: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
| Compiles an application or workspace into an output folder. | ||
|
|
||
| ```bash | ||
| $ stencil build <name> [options] |
There was a problem hiding this comment.
Consider showing command output for clarity.
It's a good practice to show the expected output of commands in documentation to help users understand what to expect.
+ # Example output:
+ $ Building project 'name'...Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
| Compiles and runs an application (or default project in a workspace). | ||
|
|
||
| ```bash | ||
| $ stencil start <name> [options] |
There was a problem hiding this comment.
Consider showing command output for the Start Command.
Including example outputs in documentation can greatly enhance user comprehension and reduce confusion.
+ # Example output:
+ $ Starting project 'name'...Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| $ stencil start <name> [options] | |
| $ stencil start <name> [options] | |
| # Example output: | |
| $ Starting project 'name'... |
Tools
Markdownlint
40-40: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
| stencil generate <schematic> <name> [options] | ||
|
|
||
| stencil g <schematic> <name> [options] | ||
| ``` |
There was a problem hiding this comment.
Consider adding an example output for the Generate Command.
Example outputs can clarify the immediate results of the command, helping users to verify correct execution.
+ # Example output:
+ $ Generated 'newApp' from 'app' schematic successfully.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| stencil generate <schematic> <name> [options] | |
| stencil g <schematic> <name> [options] | |
| ``` | |
| stencil generate <schematic> <name> [options] | |
| stencil g <schematic> <name> [options] | |
| # Example output: | |
| $ Generated 'newApp' from 'app' schematic successfully. |
Tools
Markdownlint
145-145: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
1 participant
feat: updated cli docs with cli commands
Summary by CodeRabbit
New Features
Stencil-Clicommands includingBuild,Start,Add,Info,List,Docker, andGenerate.stencil buildcommand for compiling applications.stencil startcommand for compiling and running applications.stencil addcommand for importing libraries.stencil infocommand for displaying information about installed packages.stencil listcommand for displaying installed services and package managers.stencil dockerandstencil docommands for creating Docker services.stencil generateandstencil gcommands for generating and modifying files based on schematics.Documentation
sidebars.jsto include a new 'CLI Commands' section.