{ "id": "cli/doc", "title": "ng doc", "contents": "\n
\n
\n mode_edit\n code\n
\n \n\n\n
\n \n CLI\n
\n\n \n
\n

ng doclink

\n
\n\n\n \n\n
\n \n

Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.

\n\n \nng doc <keyword> [options]\n\nng d <keyword> [options]\n\n\n\n \n\n \n\n

Arguments

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ArgumentDescriptionValue Type
<keyword>\n

The keyword to search for, as provided in the search bar in angular.io.

\n\n \n
string
\n\n\n \n\n

Options

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
OptionDescriptionValue TypeDefault Value
\n --help\n \n \n

Shows a help message for this command in the console.

\n\n \n
true|false|json|JSONfalse
\n --search\n \n \n

Search all of angular.io. Otherwise, searches only API reference documentation.

\n\n

Aliases: -s

\n
booleanfalse
\n --version\n \n \n

Contains the version of Angular to use for the documentation. If not provided, the command uses your current Angular core version.

\n\n \n
number
\n\n\n \n
\n
\n\n\n" }