diff --git a/docs/arc-api-docs/packages/cli.md b/docs/arc-api-docs/packages/cli.md new file mode 100644 index 000000000..693c29308 --- /dev/null +++ b/docs/arc-api-docs/packages/cli.md @@ -0,0 +1,152 @@ +@sourceloop/cli / + +# @sourceloop-cli + +ARC By SourceFuse logo + +This is a `sourceloop` based cli that provides commands to scaffold a monorepo, add extensions, facades and microservices to it. + +## Installation + +```shell +npm install @sourceloop/cli +``` + +After installation, use either sl or arc to run any of the CLI commands. + +## Commands + + +- sl autocomplete +- sl cdk +- sl extension +- sl help +- 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) + -o, --overwriteDockerfile + -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 + --integrateWithBackstage + --issuePrefix + --jenkinsfile + --owner +``` + +## sl update + +Update the dependencies of a LoopBack project. + +``` +USAGE + $ sl update + +``` + \ No newline at end of file diff --git a/docs/arc-api-docs/packages/pages.yml b/docs/arc-api-docs/packages/pages.yml new file mode 100644 index 000000000..6abc7b563 --- /dev/null +++ b/docs/arc-api-docs/packages/pages.yml @@ -0,0 +1,3 @@ +title: Packages +nav: + - CLI: cli.md \ No newline at end of file