Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
This site is no longer updated.Head to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

ng doc

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

      
      ng doc <keyword>
    
      
      ng d <keyword>
    

Arguments

Argument Description Value Type
keyword

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

string

Options

Option Description Value Type Default Value
--help

Shows a help message for this command in the console.

boolean
--search

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

Aliases: -s

boolean false
--version

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

string