docs(arc-api): add CLI page #136
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,152 @@ | ||||||
| @sourceloop/cli / | ||||||
|
|
||||||
| # @sourceloop-cli | ||||||
|
|
||||||
| <a style="position: relative; top: 10px;" href="https://sourcefuse.github.io/arc-docs/arc-api-docs" target="_blank"><img src="https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true" alt="ARC By SourceFuse logo" title="ARC By SourceFuse" align="right" width="150" /></a> | ||||||
|
|
||||||
| This is a `sourceloop` based cli that provides commands to scaffold a monorepo, add extensions, facades and microservices to it. | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| ```shell | ||||||
|
There was a problem hiding this comment. The word "shell" is incorrectly capitalized as "Shell" in the code block header. This should be lowercase "shell" to be consistent with standard Markdown code block syntax. |
||||||
| npm install @sourceloop/cli | ||||||
| ``` | ||||||
|
|
||||||
| After installation, use either sl or arc to run any of the CLI commands. | ||||||
|
|
||||||
| ## Commands | ||||||
|
|
||||||
| <!-- commands --> | ||||||
| - sl autocomplete | ||||||
| - sl cdk | ||||||
| - sl extension | ||||||
| - sl help | ||||||
|
There was a problem hiding this comment. The trailing space on line 23 should be removed. This appears after "sl help" and before the line break, which is inconsistent with the formatting of other command list items.
Suggested change
|
||||||
| - sl mcp | ||||||
| - sl microservice | ||||||
| - sl scaffold | ||||||
| - sl update | ||||||
|
|
||||||
| ## sl autocomplete | ||||||
|
|
||||||
| Display autocomplete installation instructions | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl autocomplete | ||||||
|
|
||||||
| OPTIONS | ||||||
| -r, --refresh-cache | ||||||
|
|
||||||
| EXAMPLES | ||||||
| $ sl autocomplete | ||||||
| $ sl autocomplete bash | ||||||
| $ sl autocomplete zsh | ||||||
| $ sl autocomplete --refresh-cache | ||||||
| ``` | ||||||
|
|
||||||
| ## sl cdk | ||||||
|
|
||||||
| Add arc-cdk to your project | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl cdk | ||||||
|
|
||||||
| OPTIONS | ||||||
| -a, --applicationClassName | ||||||
| -d, --dir | ||||||
| -i, --iac=(lambda) | ||||||
|
There was a problem hiding this comment. Line 58 has an unnecessary trailing space after "(lambda)" that should be removed for consistency. The other option lines in the documentation (lines 56, 57, 59-61) don't have trailing spaces, so this line should match that pattern.
Suggested change
|
||||||
| -o, --overwriteDockerfile | ||||||
|
There was a problem hiding this comment. Line 59 has an unnecessary trailing space after "--overwriteDockerfile" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
Suggested change
|
||||||
| -p, --packageJsonName | ||||||
| -r, --relativePathToApp | ||||||
| ``` | ||||||
|
|
||||||
| ## sl extension | ||||||
|
|
||||||
| Generate a local extension package in the packages folder. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl extension | ||||||
| ``` | ||||||
|
|
||||||
| ## sl help | ||||||
|
|
||||||
| Show help for a specific command. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl help | ||||||
| ``` | ||||||
|
|
||||||
| ## sl mcp | ||||||
|
|
||||||
| Run MCP server for CLI. This command is used internally. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl mcp | ||||||
|
|
||||||
| DESCRIPTION | ||||||
| Command that runs an MCP server for the sourceloop CLI, this is not supposed to be run directly, but rather used by | ||||||
| the MCP client to interact with the CLI commands. | ||||||
| You can use it using the following MCP server configuration: | ||||||
| "sourceloop": { | ||||||
| "command": "npx", | ||||||
| "args": ["@sourceloop/cli", "mcp"], | ||||||
| "timeout": 300 | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ## sl microservice | ||||||
|
|
||||||
| Add a microservice to services or facades folder. Supports custom and base microservice setup. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl microservice | ||||||
|
|
||||||
| OPTIONS | ||||||
| -p, --uniquePrefix | ||||||
| -s, --baseService | ||||||
| --[no-]baseOnService | ||||||
| --customMigrations | ||||||
| --datasourceName | ||||||
| --datasourceType=(postgres|mysql) | ||||||
| --[no-]facade | ||||||
| --help | ||||||
| --includeMigrations | ||||||
| --sequelize | ||||||
|
|
||||||
| ``` | ||||||
|
|
||||||
| ## sl scaffold | ||||||
|
|
||||||
| Scaffold a new ARC-based monorepo with initial structure. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl scaffold | ||||||
|
|
||||||
|
|
||||||
| OPTIONS | ||||||
| --cwd | ||||||
| --description | ||||||
| --helmPath | ||||||
| --help | ||||||
|
There was a problem hiding this comment. Line 136 has an unnecessary trailing space after "--help" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
Suggested change
|
||||||
| --integrateWithBackstage | ||||||
|
There was a problem hiding this comment. Line 137 has an unnecessary trailing space after "--integrateWithBackstage" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
Suggested change
|
||||||
| --issuePrefix | ||||||
| --jenkinsfile | ||||||
|
There was a problem hiding this comment. Line 139 has an unnecessary trailing space after "--jenkinsfile" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
Suggested change
|
||||||
| --owner | ||||||
| ``` | ||||||
|
|
||||||
| ## sl update | ||||||
|
|
||||||
| Update the dependencies of a LoopBack project. | ||||||
|
|
||||||
| ``` | ||||||
| USAGE | ||||||
| $ sl update | ||||||
|
|
||||||
| ``` | ||||||
| <!-- commandsstop --> | ||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| title: Packages | ||
| nav: | ||
|
Author
There was a problem hiding this comment. @Tyagi-Sunny Sir,this adds a single navigation item labeled "CLI" that links to the file cli.md . |
||
| - CLI: cli.md | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading
# @sourceloop-cliis inconsistent with the package name shown elsewhere in the document. The package name is@sourceloop/cli(with a forward slash), as seen in line 1, line 12, and line 96. The heading should be updated to match the actual package name@sourceloop/clifor consistency.