From bb9f04ea6595c87bff289ef70fa99de9520bd6a0 Mon Sep 17 00:00:00 2001 From: Ritchie Martori Date: Thu, 5 Sep 2013 16:52:26 -0700 Subject: [PATCH] Add command line docs --- docs.json | 3 ++- docs/cli.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 docs/cli.md diff --git a/docs.json b/docs.json index 1bcbbf6a..668fd503 100644 --- a/docs.json +++ b/docs.json @@ -8,6 +8,7 @@ "docs/concepts.md", {"title": "API", "depth": 2}, "docs/api.md", - "docs/rest.md" + "docs/rest.md", + "docs/cli.md" ] } diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 00000000..8afafaa2 --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,40 @@ +## Command Line + +The StrongLoop Suite comes bundled with a command line tool called StrongLoop +Command or `slc`. StrongLoop Command allows you to create boilerplate for +LoopBack and other StrongNode applications. + +### Commands + +`slc lb` provides the following commands. + +#### workspace + +Initialize a workspace as a new empty directory with an optional +name. The default name is "loopback-workspace". + +```sh +$ slc lb workspace my-loopback-workspace +``` + +#### api + +Create a LoopBack application in a new directory within a workspace +using the given name. The name arg is required. + +```sh +$ cd my-loopback-workspace +$ slc lb api my-app +$ slc run app +``` + +#### model +Create a model in an existing LoopBack application. If you provide the +`-i` or `--interactive` flags, you will be prompted through a model +configuration. The `--data-source` flag allows you to specify the name of a +custom data. Otheriwse it will use the data source named "db". + +```sh +$ cd my-app +$ slc lb model product +```