@ngm-dev/cli/README.md

A CLI for ui.angular-material.dev

<p align="center">
  <a href="https://ui.angular-material.dev">
    <!-- <picture>
      <img src="https://github.com/user-attachments/assets/f1c70c20-3a4c-4d36-a21e-4d87cdf4f203">
    </picture> -->
    <h1 align="center">@ngm-dev/cli</h1>
  </a>
</p>

```bash
npm install @ngm-dev/cli@latest -g
```

CLI for [ui.angular-material.dev](https://ui.angular-material.dev). Used to download code from [ui.angular-material.dev](https://ui.angular-material.dev). 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] <blocks...>
```

#### 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: ./)

### auth

Provide a token for access to private repositories.

#### 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.
- --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: ./)

### exec

Execute a block as a script.

#### Usage

```bash
@ngm-dev/cli exec [options] [script]
```

#### Options

- -A, --allow: Allow @ngm-dev/cli to download code from the provided repo.
- --verbose: Include debug logs.
- --cwd [path]: The current working directory. (default: ./)

### init

Initializes your project with a configuration file.

#### 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 <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: ./)

### setup

Setup your project to be ready to use blocks from https://ui.angular-material.dev

#### Usage

```bash
@ngm-dev/cli setup [options]
```

#### Options

- --verbose: Include debug logs.
- --cwd [path]: The current working directory. (default: ./)