This documentation is deprecated
Please see the new LoopBack documentation site.
Skip to end of metadata
Go to start of metadata

Use the slc command-line utility to create, manage, and work with LoopBack applications and other Node applications.

Command syntax

slc [command] [sub-command] [options] [args]
Icon

Some commands and sub-commands have required "options," as noted in the command reference for the specific command. Such cases are not accurately covered by the above syntax.

Syntax conventions

The documentation uses the following conventions for command-line syntax. In general:

  • An item in monospace italics represents a variable for which you can substitute a string or number, as specified for the specific command. 
  • An item enclosed in square brackets [ .. ] represents an optional item.

Then: 

command indicates one of the slc commands (see table below).

[sub-command] indicates a sub-command, for commands that take a sub-command, for example runctl or ctl.

[options] indicates one or more command options, possibly with corresponding values, as described for the particular command.  Options, as their name implies, are typically optional.  However, some commands or sub-commands have required "options," as noted in the command reference for the specific command.

Syntax for options is:

-x value: Single-letter option; separate value (if provided) with a space.
--extra=value or --extra value: Full spelled-out option; separate value (if provided) with a space or an equals sign (=).

Where value is either:

  • <foo>, a value that you must provide, either a string or number, as described for the particular command.
  • [foo], a value that you may optionally provide.  It is not required. 

[args] is an optional argument.

REVIEW COMMENT from sam
I'd suggest a fuller example, maybe take the `slc registry as an example`, I think it includes all the features you discuss here. You could present its help marked up, or maybe take it and change it into a some imaginary anonymous command so you can simplify it, and then describe the rules below, using it as an example. The help for a CLI usually has three basic secions, the one-line usage (what you show with `slc command sub-command ...etc.`), as well as commands and options.

Most slc commands have the two standard options below.  Most commands also have additional options.

STANDARD OPTIONS

-h, --help
Display help information.

-v, --version
Display version number.

Commands

The following table summarizes slc commands.  Each command has specific options and arguments, and some provide sub-commands, as described in each command reference article.

CommandDescription
slc arcStart StrongLoop Arc
buildBuild a Node application package, preparing it to be deployed.
debugDebug module with Node Inspector.
deployDeploy a Node application to a process manager.
envDisplay information about the Node runtime environment.
loopbackScaffold a LoopBack application. See Command-line reference for details.
pmManage deployed Node applications with StrongLoop Process Manager.
ctlControl applications using StrongLoop Process Manager. 
pm-installInstall StrongLoop Process Manager as an OS service.
registrySwitch between different npm registries. 
startRun an application locally, under control of StrongLoop Process Manager.
Getting the latest version of slc

See Updating to the latest version for instructions.