CLI API reference

# @ngm-dev/cli [](https://www.npmjs.com/package/@ngm-dev/cli) ```bash npm install @ngm-dev/cli@latest -g ``` Report bugs at [Angular-Material-Dev/community](https://github.com/Angular-Material-Dev/community/issues) ## Commands ### add Add blocks to your project. #### Usage ```bash @ngm-dev/cli add [options] ``` #### Options - `-E`, `--expand`: Expands the diff so you see the entire file. - `--max-unchanged [number]`: Maximum unchanged lines that will show without being collapsed. (default: 3) - `-A`, `--allow`: Allow @ngm-dev/cli to download code from the provided repo. - `-y`, `--yes`: Skip confirmation prompt. - `--verbose`: Include debug logs. - `--cwd [path]`: The current working directory. (default: `./`) - `--skip-asking-for-dependencies`: Skip asking for dependency installation. ### auth Provide a token to access https://ui.angular-material.dev #### Usage ```bash @ngm-dev/cli auth [options] [service] ``` #### Options - `--logout`: Execute the logout flow. - `--force`: Force the logout flow. Removes all the tokens for http. Useful when you create a new token or facing issues with the current token. - `--token [token]`: The token to use for authenticating to this service. Get one from https://ui.angular-material.dev/account/tokens - `--username [username]`: The username (or email) to use for authenticating to this service. - `--cwd [path]`: The current working directory. (default: `./`) - `--verbose`: Verbose output. ### init Initializes your project with a configuration file. This command will also run [setup](#setup) command to complete the setup of your project. #### Usage ```bash @ngm-dev/cli init [options] ``` #### Options - `--no-watermark`: Will not add a watermark to each file upon adding it to your project. - `--tests`: Will include tests with the blocks. - `--formatter `: What formatter to use when adding or updating blocks. - `-P`, `--project`: Takes you through the steps to initialize a project. (default: true) - `-E`, `--expand`: Expands the diff so you see the entire file. - `--max-unchanged [number]`: Maximum unchanged lines that will show without being collapsed. (default: 3) - `-y`, `--yes`: Skip confirmation prompt. - `--cwd [path]`: The current working directory. (default: `./`) - `--verbose`: Verbose output. ### update Update blocks to the code in the remote repository. #### Usage ```bash @ngm-dev/cli update [options] [blocks...] ``` #### Options - `--all`: Update all installed components. - `-E`, `--expand`: Expands the diff so you see the entire file. - `--max-unchanged [number]`: Maximum unchanged lines that will show without being collapsed. (default: 3) - `-n`, `--no`: Do update any blocks. - `-A`, `--allow`: Allow @ngm-dev/cli to download code from the provided repo. - `-y`, `--yes`: Skip confirmation prompt. - `--verbose`: Include debug logs. - `--cwd [path]`: The current working directory. (default: `./`) - `--skip-asking-for-dependencies`: Skip asking for dependency installation. ### setup Setup your project to be ready to use blocks from https://ui.angular-material.dev. This command will do following: - Creates `postcssrc.json` - Installs `tailwindcss` and `@angular/material` - Adds needed styles in `angular.json` - Configures Material Symbols #### Usage ```bash @ngm-dev/cli setup [options] ``` #### Options - `--verbose`: Include debug logs. - `--cwd [path]`: The current working directory. (default: `./`)