> For the complete documentation index, see [llms.txt](https://as-pect.gitbook.io/as-pect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://as-pect.gitbook.io/as-pect/packages/cli.md).

# @as-pect/cli

Command-line runner for `as-pect` AssemblyScript Test sessions.

## Install

```sh
npm install --save-dev @as-pect/cli assemblyscript
```

## Common commands

```sh
npx asp --init
npx asp --summary
npx asp --verbose
npx asp --update-snapshots
```

The package also installs `aspect` as an alias for `asp`.

## What this package owns

`@as-pect/cli` loads `as-pect.config.js`, plans Test session entries, invokes AssemblyScript with `as-pect.asconfig.json`, manages snapshots and coverage setup, wires reporters, and exits with a failing status when compilation or executed suites fail.

## Documentation

Detailed behavior belongs in the GitBook docs:

* [Getting started](/as-pect/docs/using/getting-started.md)
* [CLI guide](/as-pect/docs/using/cli.md)
* [CLI reference](/as-pect/docs/reference/cli-reference.md)
* [Configuration](/as-pect/docs/using/configuration.md)
* [Coverage](/as-pect/docs/using/coverage.md)
* [Built-in reporters](/as-pect/docs/extending/built-in-reporters.md)
* [`@as-pect/cli` types](/as-pect/docs/types/cli.md)

Hosted docs: [as-pect.gitbook.io/as-pect](https://as-pect.gitbook.io/as-pect/).